Contributing

Adding features or fixing bugs

• Fork the repo

• Check out a feature or bug branch

• Add your changes

• Update README when needed

• Submit a pull request to upstream repo

• Add description of your changes

• Add and ensure tests are passing

• Ensure branch is mergeable

• If possible, ruff check your code :)

Testing

• Please make sure tests pass with ./tests

Doc building

• inside docs/ : “sphinx-build -b html . html”