From: Elias Rohrer <dev@tnull.de>
Date: Tue, 6 Feb 2024 18:16:54 +0000 (+0100)
Subject: Add `rustfmt` instructions to CONTRIBUTING.md
X-Git-Tag: v0.0.123-beta~57^2~3
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=997389f3a2dbd7c7acef783241286d6e1710622e;p=rust-lightning

Add `rustfmt` instructions to CONTRIBUTING.md
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b57217165..4b8e044d1 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