How to Contribute

Requirements

Contributing Code

A good pull request:

  • Is clear.
  • Complies with the existing codebase style (pre-commit)
  • Includes docstrings and comments for unintuitive sections of code.
  • Includes documentation for new features.

Get Started

Install dependencies

poetry install -vv

After the dependencies being installed, run the command above to activate the virtualenv in your terminal

poetry shell

Linting

As a pre-deployment step we syntatically validate files with pre-commit.

Please install pre-commit then run pre-commit install to setup the git hooks. Once configured the pre-commit linters will automatically run on every git commit. Alternatively you can manually execute the validations by running pre-commit run --all-files.