| | |
| | | Contributing |
| | | ============ |
| | | # Contributing |
| | | |
| | | All projects under the Pylons Projects, including this one, follow the |
| | | guidelines established at [How to |
| | | Contribute](https://pylonsproject.org/community-how-to-contribute.html) and |
| | | [Coding Style and |
| | | Standards](https://pylonsproject.org/community-coding-style-standards.html). |
| | | All projects under the Pylons Projects, including this one, follow the guidelines established at [How to Contribute](https://pylonsproject.org/community-how-to-contribute.html), [Coding Style and Standards](https://pylonsproject.org/community-coding-style-standards.html), and [Pylons Project Documentation Style Guide](https://docs.pylonsproject.org/projects/docs-style-guide/). |
| | | |
| | | 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. |
| | | * 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](https://webchat.freenode.net/?channels=pyramid). |
| | | |
| | | Git Branches |
| | | ------------ |
| | | Git branches and their purpose and status at the time of this writing are |
| | | listed below. |
| | | ## 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. |
| | |
| | | Older branches are not actively maintained. In general, two stable branches and |
| | | one or two development branches are actively maintained. |
| | | |
| | | Prerequisites |
| | | ------------- |
| | | ## 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 |
| | | --------------------------------------------------- |
| | | ## 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 |