Skip to content
Snippets Groups Projects
Verified Commit f48b6bbb authored by Stefan Hynek's avatar Stefan Hynek :drooling_face:
Browse files

docs(readme): how to initialize pre-commit hooks

parent 1b852572
No related branches found
No related tags found
1 merge request!6Resolve "update dev environment and readme"
......@@ -3,9 +3,9 @@
## Development
1. Prerequisites
- Python 3.8
- Docker 20.10
- Docker Compose 1.25
- Python > 3.8
- Docker > 20.10
- Docker Compose > 1.25
1. Create/activate virtual environment (ensure you use the correct python version!).
```sh
......@@ -51,3 +51,11 @@ Style constraints:
Coding constraints:
- Objects that are not supposed to be used outside the current scope MUST be named starting with `_` (underscore): [PEP 316](https://www.python.org/dev/peps/pep-0316/#id12)
For your convenience, pre-commit hooks are configured to check against these constraints. Provided, you have installed the development requirements (see above), activate `pre-commit` to run on every `git commit`:
```sh
pre-commit install
```
Also, a helper with conventional commits is installed with the development requirements that you could leverage to easily comply with it. Just use `cz c` instead of `git commit`
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment