| | |
|---|
| | | |
|---|
| | | 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) and |
|---|
| | | Contribute](https://pylonsproject.org/community-how-to-contribute.html) and |
|---|
| | | [Coding Style and |
|---|
| | | Standards](http://docs.pylonsproject.org/en/latest/community/codestyle.html). |
|---|
| | | Standards](https://pylonsproject.org/community-coding-style-standards.html). |
|---|
| | | |
|---|
| | | You can contribute to this project in several ways. |
|---|
| | | |
|---|
| | |
|---|
| | | |
|---|
| | | * [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 |
|---|
| | | * [1.9-branch](https://github.com/Pylons/pyramid/tree/1.9-branch) - The branch |
|---|
| | | classified as "stable" or "latest". |
|---|
| | | * [1.6-branch](https://github.com/Pylons/pyramid/tree/1.6-branch) - The oldest |
|---|
| | | * [1.8-branch](https://github.com/Pylons/pyramid/tree/1.8-branch) - The oldest |
|---|
| | | actively maintained and stable branch. |
|---|
| | | |
|---|
| | | Older branches are not actively maintained. In general, two stable branches and |
|---|
| | |
|---|
| | | 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). |
|---|
| | | System](https://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 clone git@github.com:<username>/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 virtualenv 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 |
|---|
| | |
|---|
| | | # Windows |
|---|
| | | set VENV=c:\hack-on-pyramid\env |
|---|
| | | |
|---|
| | | 4. Install `tox` into your virtualenv. |
|---|
| | | 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 |
|---|
| | | |
|---|
| | |
|---|
| | | 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. |
|---|
