Skip to content
Snippets Groups Projects
Commit c1df3c62 authored by Moul's avatar Moul
Browse files

doc(dev) #1427: Document pre-commit usage

parent 20dac018
Branches
No related tags found
1 merge request!1396#1427: Introduce rust and gitlab-ci-linter pre-commit hooks
......@@ -82,6 +82,20 @@ If all the tests are successful, the command ends like this:
Done in 43.80s.
```
### Pre-commit hooks
We are using [`pre-commit`](https://pre-commit.com/) tool to perform checks on staged changes before committing.
We are using it for `fmt` formatting, `clippy` linter, `cargo check` and `gitlab-ci` linting.
To install the `pre-commit`, run:
```bash
sudo apt install pre-commit
```
Install the hooks:
```bash
duniter> pre-commit install
```
### Configure your IDE
Personally, I use VsCodium/VsCode, so I give the configuration for this IDE.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment