How to Participate
Reporting a Bug
When reporting a bug, be as thorough as possible. Including additional detail is encouraged. Bugs with a Pylons Project package should be reported to the individual issue tracker on GitHub.
1. Create a GitHub account
You will need to create a GitHub account account to report the bug.
2. Determine if your bug is really a bug
You should not file a bug if you are:
- Proposing features and ideas: you should provide a pull request or send email to the mailing list.
- Requesting support: there are a variety of ways to request support, from the mailing list, Stackoverflow, or #pyramid IRC channel on FreeNode.
3. Make sure your bug hasn't already been reported
Before creating an issue, search through the appropriate Issue tracker on GitHub. If you find a bug like yours, and it hasn't yet been fixed, check to see if you have new information that could be reported to help the developers fix it.
4. Collect information about the bug
To provide the developers with enough information to fix a bug, they'll need to be able to easily repeat the conditions and observe it themselves. The likelihood that a bug will be fixed is directly correlated to the developer's ability to create the conditions under which the bug may be observed.
Often a bug report should include a Python traceback (see a Python traceback). We will also need to know what platform you're running (Windows, macOS, Linux), and which Python interpreter you're running if its not CPython (e.g., Jython, Google App Engine).
5. Submit the bug
By default GitHub will email you to let you know when new comments have been made on your bug report. In the event you've turned this feature off, you should check back on occasion to ensure you don't miss any questions a developer trying to fix the bug might ask.
Bugs are reported and tracked via GitHub's issue trackers. Each Pylons Project has its own issue tracker:
- Pyramid issue tracker
- pyramid_beaker issue tracker
- pyramid_xmlrpc issue tracker
- pyramid_jinja2 issue tracker
- PylonsProject.org issue tracker (All bugs with the pylonsproject.org website should be reported here.)
Additional projects follow the same pattern:
Working on Code
To fix bugs or add features to a package managed by the Pylons project, an account on GitHub is required. All Pylons Project packages are under the Pylons organization on github.
The general practice for contributing new features and bug fixes is to fork the package and make changes within a checkout of the forked repository. Then send a pull request. This allows the developers to review the patches and accept them, or comment on what needs to be addressed before the change sets can be accepted.