Merge pull request #3111 from tnull/2024-06-rustfmt-fuzz-the-easy-part

[rust-lightning] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 78c515007d03a75ba2b0261d25ebc74f46531244..4b8e044d1d303c6d01daf4c4746e240ef4101283 100644 (file)
--- 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
 ------------------
 
 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
 
 Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
 linting


@@ -148,7 +156,7 @@ Security
 --------
 
 Security is the primary focus of `rust-lightning`; disclosure of security
 --------
 
 Security is the primary focus of `rust-lightning`; disclosure of security

-vulnerabilites helps prevent user loss of funds. If you believe a vulnerability
+vulnerabilities helps prevent user loss of funds. If you believe a vulnerability

 may affect other Lightning implementations, please inform them.
 
 You can find further information on submitting (possible) vulnerabilities in the
 may affect other Lightning implementations, please inform them.
 
 You can find further information on submitting (possible) vulnerabilities in the