]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Add `rustfmt` instructions to CONTRIBUTING.md
authorElias Rohrer <dev@tnull.de>
Tue, 6 Feb 2024 18:16:54 +0000 (19:16 +0100)
committerElias Rohrer <dev@tnull.de>
Wed, 14 Feb 2024 08:08:33 +0000 (09:08 +0100)
CONTRIBUTING.md

index b57217165e6b79c239351ebeef85647bafdab18a..4b8e044d1d303c6d01daf4c4746e240ef4101283 100644 (file)
@@ -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