From 3a8c8509dd0de3bba8f8e3ff8a0c62d8a9a6bc0c Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 7 Oct 2015 18:30:32 -0700 Subject: - grammar, rewrapping --- contributing.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 contributing.md (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md new file mode 100644 index 000000000..6ee28703c --- /dev/null +++ b/contributing.md @@ -0,0 +1,87 @@ +Contributing +============ + +All projects under the Pylons Projects, including this one, follow the +guidelines established at [How to +Contribute](http://www.pylonsproject.org/community/how-to-contribute). + +You can contribute to this project in several ways. + +* [File an Issue on GitHub](https://github.com/Pylons/pyramid/issues) +* Fork this project and create a branch with your suggested change. When ready, + submit a pull request for consideration. [GitHub + Flow](https://guides.github.com/introduction/flow/index.html) describes the + workflow process and why it's a good practice. When submitting a pull + request, sign + [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid/blob/master/CONTRIBUTORS. +txt) + if you have not yet done so. +* Join the IRC channel #pyramid on irc.freenode.net. + +Prerequisites +------------- + +Follow the instructions in HACKING.txt for your version or branch located in +the [root of the Pyramid repository](https://github.com/Pylons/pyramid/) to +install Pyramid and the tools needed to run its tests and build its +documentation. + +Building documentation for a Pylons Project project +--------------------------------------------------- + +*Note:* These instructions might not work for Windows users. Suggestions to +improve the process for Windows users are welcome by submitting an issue or a +pull request. Windows users may find it helpful to follow the guide [Installing +Pyramid on a Windows +System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.html#installing-pyramid-on-a-windows-system). + +1. Fork the repo on GitHub by clicking the [Fork] button. +2. Clone your fork into a workspace on your local machine. + + git@github.com:/pyramid.git + +3. Add a git remote "upstream" for the cloned fork. + + git remote add upstream git@github.com:Pylons/pyramid.git + +4. Set an environment variable as instructed in the + [prerequisites](https://github.com/Pylons/pyramid/blob/master/HACKING.txt#L55-L58). + + # Mac and Linux + $ export VENV=~/hack-on-pyramid/env + + # Windows + set VENV=c:\hack-on-pyramid\env + +5. Try to build the docs in your workspace. + + # Mac and Linux + $ make clean html SPHINXBUILD=$VENV/bin/sphinx-build + + # Windows + c:\> make clean html SPHINXBUILD=%VENV%\bin\sphinx-build + + If successful, then you can make changes to the documentation. You can + load the built documentation in the `/_build/html/` directory in a web + browser. + +6. From this point forward, follow the typical git workflow. Start by pulling + from the upstream to get the most current changes. + + git pull upstream master + +7. Make a branch, make changes to the docs, and rebuild them as indicated in + step 5. To speed up the build process, you can omit `clean` from the above + command to rebuild only those pages that depend on the files you have + changed. + +8. Once you are satisfied with your changes and the documentation builds + successfully without errors or warnings, then git commit and push them to + your "origin" repository on GitHub. + + git commit -m "commit message" + git push -u origin --all # first time only, subsequent can be just 'git push'. + +9. Create a [pull request](https://help.github.com/articles/using-pull-requests/). + +10. Repeat the process starting from Step 6. -- cgit v1.2.3 From 44d9304b6d875847b375cccc38820adccde20373 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 29 Oct 2015 03:54:32 -0700 Subject: - add Git Branches per https://github.com/Pylons/pyramid/pull/2050#issuecomment-151978555 - add links to resources of Coding Style and Standards and Git Workflow - fix git clone command --- contributing.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 6ee28703c..c2d2ecefd 100644 --- a/contributing.md +++ b/contributing.md @@ -3,7 +3,9 @@ Contributing All projects under the Pylons Projects, including this one, follow the guidelines established at [How to -Contribute](http://www.pylonsproject.org/community/how-to-contribute). +Contribute](http://www.pylonsproject.org/community/how-to-contribute) and +[Coding Style and +Standards](http://docs.pylonsproject.org/en/latest/community/codestyle.html). You can contribute to this project in several ways. @@ -13,11 +15,28 @@ You can contribute to this project in several ways. Flow](https://guides.github.com/introduction/flow/index.html) describes the workflow process and why it's a good practice. When submitting a pull request, sign - [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid/blob/master/CONTRIBUTORS. -txt) + [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid/blob/master/CONTRIBUTORS.txt) if you have not yet done so. * Join the IRC channel #pyramid on irc.freenode.net. +Git Branches +------------ +Git branches and their purpose and status at the time of this writing are +listed below. + +* [master](https://github.com/Pylons/pyramid/) - The branch on which further +development takes place. The default branch on GitHub. +* [1.6-branch](https://github.com/Pylons/pyramid/tree/1.6-branch) - The branch +to which further development on master should be backported. This is also a +development branch. +* [1.5-branch](https://github.com/Pylons/pyramid/tree/1.5-branch) - The branch +classified as "stable" or "latest". Actively maintained. +* [1.4-branch](https://github.com/Pylons/pyramid/tree/1.4-branch) - The oldest +actively maintained and stable branch. + +Older branches are not actively maintained. In general, two stable branches and +one or two development branches are actively maintained. + Prerequisites ------------- @@ -38,7 +57,7 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht 1. Fork the repo on GitHub by clicking the [Fork] button. 2. Clone your fork into a workspace on your local machine. - git@github.com:/pyramid.git + git clone git@github.com:/pyramid.git 3. Add a git remote "upstream" for the cloned fork. @@ -65,8 +84,9 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht load the built documentation in the `/_build/html/` directory in a web browser. -6. From this point forward, follow the typical git workflow. Start by pulling - from the upstream to get the most current changes. +6. From this point forward, follow the typical [git + workflow](https://help.github.com/articles/what-is-a-good-git-workflow/). + Start by pulling from the upstream to get the most current changes. git pull upstream master -- cgit v1.2.3 From 8be4c4501b1fd684d5e1ce24bd05be121c4813ee Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 29 Feb 2016 15:01:28 -0800 Subject: update major release descriptions --- contributing.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index c2d2ecefd..af19ed093 100644 --- a/contributing.md +++ b/contributing.md @@ -27,11 +27,8 @@ listed below. * [master](https://github.com/Pylons/pyramid/) - The branch on which further development takes place. The default branch on GitHub. * [1.6-branch](https://github.com/Pylons/pyramid/tree/1.6-branch) - The branch -to which further development on master should be backported. This is also a -development branch. -* [1.5-branch](https://github.com/Pylons/pyramid/tree/1.5-branch) - The branch -classified as "stable" or "latest". Actively maintained. -* [1.4-branch](https://github.com/Pylons/pyramid/tree/1.4-branch) - The oldest +classified as "stable" or "latest". Actively maintained. +* [1.5-branch](https://github.com/Pylons/pyramid/tree/1.5-branch) - The oldest actively maintained and stable branch. Older branches are not actively maintained. In general, two stable branches and -- cgit v1.2.3 From a575d1f9d77195d53f55fa8b409bd7c21f3f64de Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 17 Apr 2016 15:38:26 -0700 Subject: update RELEASING.txt to better account for master and previous branches - add term "final" release - explicitify the implicit - --- contributing.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index af19ed093..1393a2507 100644 --- a/contributing.md +++ b/contributing.md @@ -26,6 +26,8 @@ listed below. * [master](https://github.com/Pylons/pyramid/) - The branch on which further development takes place. The default branch on GitHub. +* [1.7-branch](https://github.com/Pylons/pyramid/tree/1.7-branch) - The branch +classified as alpha. Actively maintained. * [1.6-branch](https://github.com/Pylons/pyramid/tree/1.6-branch) - The branch classified as "stable" or "latest". Actively maintained. * [1.5-branch](https://github.com/Pylons/pyramid/tree/1.5-branch) - The oldest -- cgit v1.2.3