Setup

In order to contribute you will need to clone/fork the repo and install the requirements locally.

pip install .

pip install pre-commit
pre-commit install

Workflow

Create and checkout new feature branch for your work.
Make changes and add awesome code!
Run code-style requirement checks using pre-commit and fix all documentation and typing issues shown in the output.

pre-commit run --all-files -v

Run tests locally.
Re-stage the files after fixing the errors and commit. When you commit, pre-commit will run once again but only on the changed files
Push to remote. Create a PR if your feature is complete.

We use flake8 and black for code formatting.