From ceeef8411c560a3a400cc78f55a4729775d186c1 Mon Sep 17 00:00:00 2001 From: bdvllrs Date: Wed, 6 Mar 2024 10:17:30 +0000 Subject: [PATCH] Add information about pre-commits in CONTRIBUTING --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f3915e6..3770a1ea 100644 --- 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