From bc2232f2e4e6ffb9cf25c71efb934e9a8149c3ce Mon Sep 17 00:00:00 2001 From: Moul <moul@moul.re> Date: Wed, 12 May 2021 18:41:52 +0200 Subject: [PATCH] [doc] #162: Document the pre-commit hooks in use --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc695d8c..7c54eec0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,8 @@ # Contribute guide ## Pre-commit -We are using [`pre-commit`](https://pre-commit.com/) tool to perform checks on staged changes before committing. Such as black formatting. +We are using [`pre-commit`](https://pre-commit.com/) tool to perform checks on staged changes before committing. +We are ussing it for `black` formatting, `isort` imports sorting, `pylint`, `mypy`, and `gitlab-ci` linting. Depending whether you prefer to work ouside or inside Poetry virtual environment, you should stick to one usage or use both to still have this usefull checks. `pre-commit` can be used from the installation on your system or from inside Poetry virtual environment where it is installed. -- GitLab