We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 2209806 commit 3e23f67Copy full SHA for 3e23f67
1 file changed
CONTRIBUTING.md
@@ -13,4 +13,13 @@ Welcome! Thanks for your interest in contributing to this project.
13
14
## Coding conventions
15
16
-TBD
+- We use `pre-commit` to enforce code-style conventions.
17
+- You can install `pre-commit` following the instructions [here](https://pre-commit.com/#install).
18
+- Run `pre-commit install` inside your locally-checked-out repository to activate it.
19
+- You can also run the style checks without installing `pre-commit` by running `uv run --group dev pre-commit run --all-files`
20
+
21
+## Tests
22
23
+We encourage the use of tests across the whole codebase.
24
+Run the `pytest` tests with `uv run --group dev pytest`.
25
+Run the `mypy` checks with `uv run --group dev mypy .`.
0 commit comments