@@ -12,9 +12,12 @@ First off, thank you for considering contributing to this project!
1212
13132 . ** Install dependencies using ` uv ` :**
1414 ``` bash
15- uv venv
16- source .venv/bin/activate
17- uv pip install -e " .[dev]"
15+ uv sync --extra dev --extra docs
16+ ```
17+
18+ ` pip ` fallback:
19+ ``` bash
20+ pip install -e " .[dev,docs]"
1821 ```
1922
20233 . ** Install pre-commit hooks:**
@@ -26,12 +29,14 @@ First off, thank you for considering contributing to this project!
2629
2730We use a ` Makefile ` to simplify common tasks:
2831
29- - ` make format ` : Formats code using ` ruff ` .
30- - ` make check ` : Runs linters (` ruff check ` ) and type checkers (` basedpyright ` , ` ty ` ).
31- - ` make tests ` : Runs the test suite using ` pytest ` .
32- - ` make all ` : Runs formatting and checking consecutively.
32+ - ` make format ` : Formats code using ` uv run ruff format ` .
33+ - ` make check ` : Runs the repo-default validation pass with ` uv ` .
34+ - ` make check-matrix ` : Runs ` ruff ` , ` ty ` , and ` basedpyright ` under Python ` 3.11 ` , ` 3.12 ` , and ` 3.13 ` .
35+ - ` make tests ` : Runs the test suite using ` uv run pytest ` .
36+ - ` make all ` : Runs ` make format ` then ` make check ` .
37+ - ` make prod ` : Runs ` make tests ` , ` make format ` , and ` make check-matrix ` .
3338
34- Before submitting a Pull Request, please ensure ` make all ` and ` make tests ` run without any errors.
39+ Before submitting a Pull Request, ensure ` make prod ` runs without errors.
3540
3641## Pull Requests
3742
0 commit comments