Contributing

All projects under the Pylons Projects, including this one, follow the
guidelines established at How to
Contribute.

You can contribute to this project in several ways.

File an Issue on GitHub
Fork this project and create a branch with your suggested change. 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](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.

Prerequisites

Follow the instructions in HACKING.txt for your version or branch located in
the root of the Pyramid repository to
install Pyramid and the tools needed to run its tests and build its
documentation.

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
pull request. Windows users may find it helpful to follow the guide Installing
Pyramid on a Windows
System.

Fork the repo on GitHub by clicking the [Fork] button.
Clone your fork into a workspace on your local machine.
```
 git@github.com:<username>/pyramid.git
```

Add a git remote "upstream" for the cloned fork.

 git remote add upstream git@github.com:Pylons/pyramid.git

Set an environment variable as instructed in the
prerequisites.

 # Mac and Linux
 $ export VENV=~/hack-on-pyramid/env

 # Windows
 set VENV=c:\hack-on-pyramid\env

Try to build the docs in your workspace.
```
 # Mac and Linux
 $ make clean html SPHINXBUILD=$VENV/bin/sphinx-build

 # Windows
 c:\> make clean html SPHINXBUILD=%VENV%\bin\sphinx-build
```
If successful, then you can make changes to the documentation. You can
load the built documentation in the /_build/html/ directory in a web
browser.
From this point forward, follow the typical git workflow. Start by pulling
from the upstream to get the most current changes.
```
 git pull upstream master
```
Make a branch, make changes to the docs, and rebuild them as indicated in
step 5. To speed up the build process, you can omit clean from the above
command to rebuild only those pages that depend on the files you have
changed.
Once you are satisfied with your changes and the documentation builds
successfully without errors or warnings, then git commit and push them to
your "origin" repository on GitHub.
```
 git commit -m "commit message"
 git push -u origin --all # first time only, subsequent can be just 'git push'.
```
Create a pull request.
Repeat the process starting from Step 6.