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.
Git branches and their purpose and status at the time of this writing are listed below.
- master - The branch which should always be deployable. The default branch on GitHub.
- For development, create a new branch. If changes on your new branch are accepted, they will be merged into the master branch and deployed.
We use tox to automate test running, coverage, and building documentation across all supported Python versions.
To run everything configured in the tox.ini file:
$ tox
To run tests on Python 2 and 3, and ensure full coverage, but exclude building of docs:
$ tox -e py2-cover,py3-cover,coverage
To build the docs only:
$ tox -e docs
See the tox.ini file for details.