CONTRIBUTING.md

Contributing Guidelines

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Make sure your request is meaningful and you have tested the app locally before submitting a pull request.

Installing Requirements

Software Requirements

• Python 3.7+

Development Dependencies

Install development dependencies with:

pip install -e ".[dev]"

Install documentation dependencies with:

pip install -e ".[docs]"

Install runtime dependencies with:

pip install -e .

All dependencies can be installed at once with:

pip install -e ".[dev,docs]"

Running the Tests

Run the following command to run the Tox test script which will verify that the tested functionality is still working.

task test

Linting

Black, isort, and pre-commit hooks are used to lint the codebase. Run the following command to lint and fix the codebase.

task lint

Pyright

To ensure that type hints are used correctly, Pyright is used to lint the codebase. Run the following command to check for typing errors.

task pyright

Documentation

To view the documentation locally, run the following command.

task docs

The documentation will be served at http://127.0.0.1:8888.

Need some help regarding the basics?

You can refer to the following articles on the basics of Git and GitHub in case you are stuck:

• Forking a Repo
• Cloning a Repo
• How to create a Pull Request
• Getting started with Git and GitHub
• Learn GitHub from Scratch