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 From 6d42e2d4118cdc656bbb8301cf5a08adb4b855d5 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Thu, 19 May 2016 22:32:12 -0500 Subject: update contributing to reference 1.7 as stable --- contributing.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 1393a2507..ae201d370 100644 --- a/contributing.md +++ b/contributing.md @@ -25,13 +25,11 @@ 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. + 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 -actively maintained and stable branch. + classified as "stable" or "latest". +* [1.6-branch](https://github.com/Pylons/pyramid/tree/1.6-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. -- cgit v1.2.3 From 96a62f361a97ccf73738f3b576962817fc515305 Mon Sep 17 00:00:00 2001 From: cewing Date: Fri, 3 Jun 2016 10:31:08 -0700 Subject: update contributing docs to reflect current practice and clarify steps --- contributing.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index ae201d370..922d2e740 100644 --- a/contributing.md +++ b/contributing.md @@ -56,11 +56,15 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht git clone git@github.com:/pyramid.git +2. Change directories into the cloned repository + + cd pyramid + 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 +4. Create a virtualenv and set an environment variable as instructed in the [prerequisites](https://github.com/Pylons/pyramid/blob/master/HACKING.txt#L55-L58). # Mac and Linux @@ -69,28 +73,26 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht # Windows set VENV=c:\hack-on-pyramid\env -5. Try to build the docs in your workspace. +4. Install `tox` into your virtualenv. - # Mac and Linux - $ make clean html SPHINXBUILD=$VENV/bin/sphinx-build + $ $VENV/bin/pip install tox - # Windows - c:\> make clean html SPHINXBUILD=%VENV%\bin\sphinx-build +5. Try to build the docs in your workspace. + + $ $VENV/bin/tox -e docs - 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. + When the build finishes, you'll find HTML documentation rendered in + `.tox/docs/html`. An `epub` version will be in `.tox/docs/epub`. And the + result of the tests that are run on the documentation will be in + `.tox/docs/doctest`. 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. + *Always* 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. +7. Make a branch, make changes to the docs, and rebuild them as indicated above. 8. Once you are satisfied with your changes and the documentation builds successfully without errors or warnings, then git commit and push them to @@ -101,4 +103,4 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht 9. Create a [pull request](https://help.github.com/articles/using-pull-requests/). -10. Repeat the process starting from Step 6. +10. Repeat the process starting from Step 8. -- cgit v1.2.3 From 21227087f7f933eaae364627d8908f19c32c9990 Mon Sep 17 00:00:00 2001 From: cewing Date: Fri, 3 Jun 2016 10:50:45 -0700 Subject: make term less specific to one implementation --- contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 922d2e740..33a9dc55b 100644 --- a/contributing.md +++ b/contributing.md @@ -64,7 +64,7 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht git remote add upstream git@github.com:Pylons/pyramid.git -4. Create a virtualenv and set an environment variable as instructed in the +4. Create a virtual environment and set an environment variable as instructed in the [prerequisites](https://github.com/Pylons/pyramid/blob/master/HACKING.txt#L55-L58). # Mac and Linux @@ -73,7 +73,7 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht # Windows set VENV=c:\hack-on-pyramid\env -4. Install `tox` into your virtualenv. +4. Install `tox` into your virtual environment. $ $VENV/bin/pip install tox -- cgit v1.2.3 From aaca3310e15c4528de41c9b0a26ccbf1d5ce3763 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 3 Jun 2016 11:36:35 -0700 Subject: fix up numbering --- contributing.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 33a9dc55b..b5f17ae06 100644 --- a/contributing.md +++ b/contributing.md @@ -56,15 +56,15 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht git clone git@github.com:/pyramid.git -2. Change directories into the cloned repository +3. Change directories into the cloned repository cd pyramid -3. Add a git remote "upstream" for the cloned fork. +4. Add a git remote "upstream" for the cloned fork. git remote add upstream git@github.com:Pylons/pyramid.git -4. Create a virtual environment and set an environment variable as instructed in the +5. Create a virtual environment and set an environment variable as instructed in the [prerequisites](https://github.com/Pylons/pyramid/blob/master/HACKING.txt#L55-L58). # Mac and Linux @@ -73,11 +73,11 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht # Windows set VENV=c:\hack-on-pyramid\env -4. Install `tox` into your virtual environment. +6. Install `tox` into your virtual environment. $ $VENV/bin/pip install tox -5. Try to build the docs in your workspace. +7. Try to build the docs in your workspace. $ $VENV/bin/tox -e docs @@ -86,21 +86,21 @@ System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.ht result of the tests that are run on the documentation will be in `.tox/docs/doctest`. -6. From this point forward, follow the typical [git +8. From this point forward, follow the typical [git workflow](https://help.github.com/articles/what-is-a-good-git-workflow/). *Always* 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 above. +9. Make a branch, make changes to the docs, and rebuild them as indicated above. -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. +10. 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/). +11. Create a [pull request](https://help.github.com/articles/using-pull-requests/). -10. Repeat the process starting from Step 8. +12. Repeat the process starting from Step 8. -- cgit v1.2.3