To contribute code changes or update the documentation, please follow these steps:
- Fork the upstream repository and clone the fork locally.
- Install prek (a Rust rewrite of pre-commit):
# Using uv (recommended)
uv tool install prek
# Or using pip
pip install prek- Navigate to the cloned repository's directory and install the hooks by running:
prek install && prek install --hook-type commit-msg- 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.
- we follow conventional commits and this is enforced using commitlint via a pre-commit hook.