Add information about pre-commits in CONTRIBUTING

ruflab · Mar 6, 2024 · ceeef84 · ceeef84
1 parent cae7e98
commit ceeef84
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -31,8 +31,14 @@ poetry run ruff check . --fix  # lint the project (and fix errors if ruff can)
 ```sh
 poetry run ruff format .  # reformat the project
 ```
+
+> [!NOTE]
+> There is a [pre-commit](https://pre-commit.com/) configuration set to lint and
+> reformat usinf ruff. Set it up to everything with each commit.
+
+To check type issues with mypy:
 ```sh
-poetry run mypy .
+poetry run mypy --install-types .
 ```
 
 ## Tests