Add note about pre-commit

This commit is contained in:
jo 2021-06-03 14:17:10 +02:00
parent 35e325fbf0
commit b75d9e5c59
1 changed files with 15 additions and 0 deletions

View File

@ -31,3 +31,18 @@ For bug reports, please provide the following details:
Please wrap all code and error messages in [markdown code Please wrap all code and error messages in [markdown code
fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/). fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/).
### Contributing code
To make sure that you don't accidentally commit code that does not follow the coding style, you can
install a [`pre-commit`](https://pre-commit.com/) hook that will check that everything is in order:
```bash
pre-commit install
```
You can also run it anytime using:
```bash
pre-commit run --all-files
```