How to Contribute

We are happy to accept contributions to this project. Please follow the instructions below.

Code reviews

All submissions will require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Documentation improvement

Our documentation is automatically generated using pdoc3 and deployed (along with our website) on the gh-pages branch of this repository (see generate_doc.yml)

If you want to modify the home, use the documentation.md file.

For modifications on the documentation associated to a method or a class, edit the docstring in the concerned file.

Once you modifications done, please consider creating a pull request.