In this PR, I added the configuration for linter/formatters and for the pre-commit framework. I did not run the linter/formatter which I will do in a separate PR as it will yield a large git diff.
The tools include:
codespell to check for spelling typos
isort to sort imports in python files
ruff to replace flake8 and black (formatter) to auto-format python files to the current standard
yamllint to lint the added yaml files
The pre-commit frameworks let you run those linting tools before committing. It is not mandatory, if you want to use it, you need to run:
pip install pre-commit
pre-commit install
This last line must be run from the root of the repository (it adds some stuff in .git).
Once this PR is merged, you can also go to https://pre-commit.ci/ and setup this repository (it's very simple and quick). It will add a pre-commit CI which runs the style checks. On PRs, it will also automatically commit changes if some of those style check modified files (the formatters 😉).
PR independent from #22
In this PR, I added the configuration for linter/formatters and for the pre-commit framework. I did not run the linter/formatter which I will do in a separate PR as it will yield a large git diff.
The tools include:
codespell
to check for spelling typosisort
to sort imports in python filesruff
to replaceflake8
andblack
(formatter) to auto-format python files to the current standardyamllint
to lint the addedyaml
filesThe
pre-commit
frameworks let you run those linting tools before committing. It is not mandatory, if you want to use it, you need to run:This last line must be run from the root of the repository (it adds some stuff in
.git
). Once this PR is merged, you can also go to https://pre-commit.ci/ and setup this repository (it's very simple and quick). It will add apre-commit
CI which runs the style checks. On PRs, it will also automatically commit changes if some of those style check modified files (the formatters 😉).