Skip to content

Commit 77c9d82

Browse files
modify the guideline to refer to pre-commit hooks
1 parent b992591 commit 77c9d82

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
## Rust
44

5-
- Before you commit, make sure that your code compiles with `cargo check` and
6-
that it has been formatted properly; `cargo fmt` does that for you. Also
7-
check if your changes introduce any new linter warnings by running `cargo
8-
clippy`
5+
- Before you commit, make sure that you have [pre-commit](https://pre-commit.com/)
6+
installed. This will ensure that the code is formatted correctly and that
7+
it compiles properly. Also, check if your changes introduce any new linter
8+
warnings by running `cargo clippy`.
99
- Make sure to keep `CHANGELOG.md` up-to-date.
1010
- Make sure not to use Rust features newer than the specified minimum supported
1111
Rust Version (MSRV), which is documented in the [README](README.md). You can

docs/maintainers-guide.md

+1
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
- `_config.yml`: configuration file for PineAPPL's Github-pages website
4949
- `install-capi.sh`: POSIX-compliant shell script to download and install
5050
PineAPPL's pre-built CAPI
51+
- `.pre-commit-config.yaml`: pre-commit hooks configuration
5152

5253
[cargo-xtask]: https://github.com/matklad/cargo-xtask
5354
[release page]: https://github.com/NNPDF/pineappl/releases

0 commit comments

Comments
 (0)