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