Skip to content

Commit 568cb4f

Browse files
docs: improve linting description
Co-authored-by: dropforge <[email protected]>
1 parent 9fead3a commit 568cb4f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ Test the code with `python manage.py test myhpi.tests`.
3232

3333
### Code style
3434

35-
We recommend installing a pre-commit hook with `pre-commit install`. That will (look at `.pre-commit-config.yaml`) before every commit
35+
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:
3636

3737
- run `autoflake` with a couple of flags to remove unused imports,
3838
- run `isort .` to sort imports,
3939
- run `black .` to format the python code. You can also check out the [IDE integration](https://github.com/psf/black#editor-integration)
40-
- 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)
40+
- 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
4141

4242
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.
4343

0 commit comments

Comments
 (0)