Developers’ guide

Getting the source code

We use the Git version control system. The best way to contribute is through GitHub. You will first need a GitHub account, and you should then fork the repository.

Working on the documentation

The documentation is written in reStructuredText, using the Sphinx documentation system. To build the documentation:

>>> cd expipe/docs
>>> make html

Then open doc/build/html/index.html in your browser.

Committing your changes

Once you are happy with your changes, run the test suite again to check that you have not introduced any new bugs. Then you can commit them to your local repository:

>>> git commit -m 'informative commit message'

If this is your first commit to the project, please add your name and affiliation/employer to doc/source/authors.rst

You can then push your changes to your online repository on GitHub:

>>> git push

Once you think your changes are ready to be included in the main Expipe repository, open a pull request on GitHub (see