Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 788 Bytes

File metadata and controls

18 lines (13 loc) · 788 Bytes

How to contribute

Please make sure to make a change grounded in the reality of production code and not based on theoretical issues that might never arises. The code is complex already as it is.

Step 1. Open an Issue to describe what you intend to do

So that everyone is aware of the intention before getting a surprise PR

Step 2. Work in a branch

Make sure to work in a branch to make it easier to create a new PR.

Important: Update the unit tests each time! We use TDD for this project.

Step 3. Run pre-commit

Install the dev dependencies with uv sync --group dev, then run uv run pre-commit run --all-files. This will run all the necessary tests and linters, saving lots of time to the reviewers.

Step 4. Open a PR to review

Refer the Issue number in your PR