Contributing

Welcome contributors!

Thank you for taking the time to contribute to this project. Your help is highly appreciated.

The rules are pretty simple:

• Use Discussions for proposing major changes.
• This repo uses black & flake8 for style and formatting via pre-commit hooks. Kindly make sure you run it before submitting a PR. Refer Pull Request Process below.

Pull Request Process

1. Fork and clone the repo.

2. Install poetry as specified here. and setup the dev environment as follows:

   poetry install -E dev -E doc -E test
   

   Running poetry shell will now put you in the dev environment.

3. Setup pre-commit hooks by running pre-commit install in the dev environment. Now pre-commit will run on every git commit. Alternatively, you could just run pre-commit run --all-files after you're done.

4. Confirm tests are passing by running tox.

5. Submit PR.