Skip to content

Commit 3e23f67

Browse files
committed
📝 Add notes about running tests and style checks
1 parent 2209806 commit 3e23f67

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,13 @@ Welcome! Thanks for your interest in contributing to this project.
1313

1414
## Coding conventions
1515

16-
TBD
16+
- 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

Comments
 (0)