diff --git a/README.md b/README.md index 72db7daa..c25c7aab 100644 --- a/README.md +++ b/README.md @@ -32,12 +32,12 @@ Test the code with `python manage.py test myhpi.tests`. ### Code style -We recommend installing a pre-commit hook with `pre-commit install`. That will (look at `.pre-commit-config.yaml`) before every commit +We recommend installing a pre-commit hook with `pre-commit install`. The [hook](.pre-commit-config.yaml) will do the following steps before every commit: - run `autoflake` with a couple of flags to remove unused imports, - run `isort .` to sort imports, - run `black .` to format the python code. You can also check out the [IDE integration](https://github.com/psf/black#editor-integration) -- run `prettier-eslint --write --list-different` to format the JavaScript code and Markdown files. You can also check out the [Prettier IDE integration](https://prettier.io/docs/en/editors.html) +- run `prettier-eslint --write --list-different` to format the JavaScript code and Markdown files. You can also check out the [Prettier IDE integration](https://prettier.io/docs/en/editors.html), e. g. the [prettier-eslint](vscode:extension/rvest.vs-code-prettier-eslint) Visual Studio Code extension If you want to do that manually, run `pre-commit run --all-files`. Next to that, we also run `pylint myhpi` to check for semantic issues in the code.