Contributing

I'm assuming you're looking for a way to contribute to the project. I truly appreciate that. Thank you!

1

Explore the issues or create one

If you have a major change in mind, create an issue first. Once we agree on the discussion, feel free to proceed and make your changes.

2

Clone and start your work

3

Quality check your changes

We use tox to perform quality checks, format code, check types, and ensure our changes pass the tests.

If you use pip

pip install tox

Once the installation is complete, run tox for a full check.

If you use uv

uvx --with tox-uv tox
4

Open a PR

Finally, once everything is ready, open a PR, and I'll review your changes.

Updated on