CONTRIBUTIONS.rst
How to Contribute
=================
- Overview_
- Guidelines_
- Branching_
Overview
--------
1. Fork the repo.
2. Improve/fix the code.
3. Add your changes to CHANGES.rst
4. Add your name to AUTHORS.md
5. Push to your fork
6. Write a test for your work
7. Submit a pull request to the ``staging`` branch.
Guidelines
----------
Some simple guidelines to follow when contributing code:
- Code should be clean and readable
- All added functions, interfaces and classes must be documented.
Branching
---------
There are two main development branches: ``master``, and ``staging``. ``master`` represents the currently released version. ``staging`` contains the code under scrutinization for deployment to ``master``.