Skip to content

Commit

Permalink
modify the guideline to refer to pre-commit hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
Radonirinaunimi committed Sep 18, 2024
1 parent b992591 commit 77c9d82
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Rust

- Before you commit, make sure that your code compiles with `cargo check` and
that it has been formatted properly; `cargo fmt` does that for you. Also
check if your changes introduce any new linter warnings by running `cargo
clippy`
- Before you commit, make sure that you have [pre-commit](https://pre-commit.com/)
installed. This will ensure that the code is formatted correctly and that
it compiles properly. Also, check if your changes introduce any new linter
warnings by running `cargo clippy`.
- Make sure to keep `CHANGELOG.md` up-to-date.
- Make sure not to use Rust features newer than the specified minimum supported
Rust Version (MSRV), which is documented in the [README](README.md). You can
Expand Down
1 change: 1 addition & 0 deletions docs/maintainers-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
- `_config.yml`: configuration file for PineAPPL's Github-pages website
- `install-capi.sh`: POSIX-compliant shell script to download and install
PineAPPL's pre-built CAPI
- `.pre-commit-config.yaml`: pre-commit hooks configuration

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

0 comments on commit 77c9d82

Please sign in to comment.