1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
# Contributing
All projects under the Pylons Project, 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/pylons-sphinx-themes/issues).
* 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](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/pylons-sphinx-themes/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.
* [master](https://github.com/Pylons/pylons-sphinx-themes/) - 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.
## Prerequisites
Follow the instructions in [README.rst](https://github.com/Pylons/pylons-sphinx-themes/) to install the tools needed to run the project.
|
