Skip to content

Commit

Permalink
docs: improve linting description
Browse files Browse the repository at this point in the history
Co-authored-by: dropforge <[email protected]>
  • Loading branch information
SilvanVerhoeven and dropforge committed Jul 29, 2024
1 parent b058128 commit 66fdf27
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 66fdf27

Please sign in to comment.