Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (30 loc) · 963 Bytes

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 963 Bytes

How to contribute

Dependencies

We use poetry to manage the dependencies.

To install them you would need to run two commands:

poetry install

Tests

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

pytest

To run linting:

flake8 .

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 and flake8 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 and flake8 again to make sure it is still working

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?