Contributing

Would you like to contribute? Great!

Feedback

Please leave feedback, bug reports and feature requests into the issue tracker in GitHub.

Pull requests

You are more than welcome to contribute code to the project via GitHub pull requests.

The project uses flit for dependency management.

$ python -m venv venv
$ activate venv/bin/activate
(venv) $ pip install flit
(venv) $ flit install --symlink --deps=develop

Before creating PR, please make sure that all tests pass by running tox:

(venv) $ tox

For new features you should also update the documentation and ensure it compiles:

(venv) $ cd docs/
(venv) $ make html