Want to contribute to this project? Awesome news! Here are some guidelines to get you started.
Note: before writing any code, be sure to open an issue if the change you're proposing is not trivial.
- Fork this repo and clone it to your machine.
- Create a virtual environment and install development dependencies:
python -m venv venv
. venv/bin/activate
pip install -r requirements.txt- Work on a separate branch, e.g.
fix/some-bug. - Make sure tests pass before pushing your code. To run the test suite, use:
pytest- Once the feature or bug fix is ready enough to be reviewed, open a pull request!