From 997389f3a2dbd7c7acef783241286d6e1710622e Mon Sep 17 00:00:00 2001 From: Elias Rohrer Date: Tue, 6 Feb 2024 19:16:54 +0100 Subject: [PATCH] Add `rustfmt` instructions to CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5721716..4b8e044d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,7 +120,15 @@ Coding Conventions ------------------ Use tabs. If you want to align lines, use spaces. Any desired alignment should -display fine at any tab-length display setting. +display fine at any tab-length display setting. We use `rustfmt` to establish +uniform coding standards throughout the codebase. Please run + +```bash +./ci/rustfmt.sh +``` + +before committing and pushing any changes, as compliance will also be checked +and enforced by our CI scripts. Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default linting -- 2.30.2