Thank you for your interest in contributing to our project. Before contributing, please check existing issues. If there is a bug or feature that is not listed, create a new issue and make changes on it.
This project repository has configured development container. Get a quick start with GitHub Codespaces or VS Code Dev Containers.
We use Ruff to format codes and check types using mypy. Format codes with:
$ make format
$ make lintOnce changes made, it should be tested. We use pytest for testing.
Run tests with:
$ make testWe will review your PR and reply as soon as possible.
Docs are generated using MkDocs. To see docs locally with live reloading:
$ make serve-docsGo to http://localhost:8000 and you will see the docs preview.