Contributor Guide

First of all, thank you for taking the time out to contribute to this project. We use the following to track the progress of the project:

• Issues
• Pull Requests
• Discussions
• Project Board

Please feel free to have a look at the above and ask any questions you have about the project.

Local Development Setup

This project uses pre-commit to run some scripts before each commit.

To initialize the pre-commit hooks, run the following command in the project root directory after installing the project:

$ pre-commit install

The pre-commit runs the following before each commit:

• isort to keep all the imports sorted alphabetically
• flake8 to check for PEP8 compliance
• black to format the code

This ensures that the code is always in a consistent state before each commit and we are following proper code styles and conventions.

Code Style Guide

We follow the PEP8 style guide for Python and use flake8 to check for PEP8 compliance before committing the code.

For formatting, we use black formatter, which is also compliant with PEP8.

Testing

We use pytest for testing the module. GitHub Action has been installed to run tests on every PR. You must pass all the test for the PR to be merged.