Skip to content
Snippets Groups Projects
Commit 5bf66265 authored by Hans Fangohr's avatar Hans Fangohr Committed by Ashwin Kumar Karnad
Browse files

Apply changes from Hanss changes

parent 557f2d02
No related branches found
No related tags found
1 merge request!78Add pre-commit hooks
Pipeline #373064 canceled
...@@ -4,15 +4,15 @@ This section is for developers wanting to contribute to the project. ...@@ -4,15 +4,15 @@ This section is for developers wanting to contribute to the project.
Setup pre-commit hooks Setup pre-commit hooks
---------------------- ----------------------
The project uses [pre-commit](https://pre-commit.com/) to run some checks before committing code. The project uses `pre-commit <https://pre-commit.com/>`__ to run some checks before committing code.
Install pre-commit by running the following command: Install pre-commit by running the following command::
pip install pre-commit pip install pre-commit
To setup the pre-commit hooks, run the following command from the root of the project: To setup the pre-commit hooks, run the following command from the root of the project::
pre-commit install pre-commit install
Then every time you commit, pre-commit will run all checks defined in `.pre-commit-config.yaml`. Then every time you commit, pre-commit will run all checks defined in `.pre-commit-config.yaml`.
you can run the pre-commit checks manually by running: you can run the pre-commit checks manually by running::
pre-commit run --all-files pre-commit run --all-files
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