From 3ec09711eb70f9ab4b8517d81265b381dfae8990 Mon Sep 17 00:00:00 2001 From: Ivan Gulakov Date: Sun, 4 May 2025 18:58:17 +0200 Subject: [PATCH] Add a mention of precommit.sh to CONTRIBUTING.md (#3194) --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7477a9636..4c086a24c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,8 @@ Even though we will gladly assist you in finishing up your PR, try to: - run `cargo build --no-default-features` to check for `no_std` compatibility (and possibly add `#[cfg(feature = "std")]`) to hide parts of your code. - Please add and describe your changes to MIGRATION.md if you change the APIs. +You can also run ./scripts/precommit.sh to execute checks that will be performed on a PR. + Some of the parts in this list may be hard, don't be afraid to open a PR if you cannot fix them by yourself, so we can help. ### Pre-commit Hooks