duniterpy#169: Update pre-commit doc. Document CI linter hook usage
All threads resolved!
All threads resolved!
Compare changes
+ 33
− 7
@@ -30,7 +30,7 @@ silkaj> cd ..
@@ -30,7 +30,7 @@ silkaj> cd ..
@@ -47,19 +47,45 @@ Please read their documentations on how to use them the best possible.
@@ -47,19 +47,45 @@ Please read their documentations on how to use them the best possible.
We are using [`pre-commit`](https://pre-commit.com/) tool to perform checks on staged changes before committing.
We are using it for `black` formatting, `isort` imports sorting, and `gitlab-ci` linting. We will use it for `pylint` code linting, `mypy` typing in the future.
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.