CONTRIBUTING.md

How to contribute

Dependencies

We use poetry to manage the dependencies.

To install them:

poetry install

Tests

We use pytest and flake8 for quality control. To run all tests:

pytest

To run linting:

flake8

You can also run all checks for all python versions at once by:

tox

Make sure you have followed all the steps before submitting your PR.

Before submitting

Before submitting your code please do the following steps:

1. Run pytest to make sure everything was working before
2. Add any changes you want
3. Adds tests for the new changes
4. Edit documentation if you have changed something significant
5. Run pytest again to make sure it is still working
6. Run flake8 to make sure that your code is passing our style check

Other help

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. What are your best practices?