To contribute code changes or update the documentation, please follow these steps:
- Fork the upstream repository and clone the fork locally.
- Install poetry, and install the project's dependencies with
poetry install - Install pre-commit and install the hook by running
pre-commit install - Make whatever changes and additions you wish and commit these - please try to keep your commit history clean.
- Create a pull request to the main repository with an explanation of your changes
Note: if you add new code or modify existing code - 100% test coverage is mandatory and tests should be well written.