CONTRIBUTING.md

Contribution Guidelines + Tutorial

[!INFO] TL;DR: Keep your code clean.

Pull requests

Before submitting a pull request, make sure to lint and format your code. If you build a project, make sure to exclude those directories from the pull request.

ruff format
ruff check

Maintenance

Go into requirements.txt and update the dependencies if compatible. Then run this.

uv add -r requirements.txt
uv lock --upgrade
uv sync