All projects under the Pylons Project, including this one, follow the guidelines established at How to Contribute, Coding Style and Standards, and Pylons Project Documentation Style Guide.
You can contribute to this project in several ways.
- File an Issue on GitHub
- Fork this project, create a new branch, commit your suggested change, and push to your fork on GitHub. When ready, submit a pull request for consideration. GitHub Flow describes the workflow process and why it's a good practice. When submitting a pull request, sign CONTRIBUTORS.txt if you have not yet done so.
- Join the IRC channel #pyramid on irc.freenode.net.
There is a single branch master on which development takes place and from which releases to PyPI are tagged. This is the default branch on GitHub.
Follow the instructions to install Pyramid and the tools needed to build its documentation in HACKING.txt. We will leverage this virtual environment and the tools installed there to build documentation for this project. This has several advantages:
- You don't have to install Sphinx and its dependencies another time.
- You are encouraged to contribute to the official documentation.
- No increased maintenance for the Pylons Project.