Contributing¶
All project management tools are on GitHub:
- Bug tracking are in issues
- Patches are submitted as pull requests
Workflow¶
- Fork project on GitHub.com
- Make changes (and new unit tests if needed)
- Ensure all tests are ok
- Go to your fork and click on “Create pull request”
Tests¶
All tests are simply launched by:
python setup.py test
Or with coverage:
coverage run setup.py test
coverage html
Writing documentation¶
This documentation is built with Sphinx, make your local docs with following commands:
make html
cd _build/html
python -m SimpleHTTPServer