X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=4b8e044d1d303c6d01daf4c4746e240ef4101283;hb=refs%2Fheads%2Fupstream%2Fmain;hp=b57217165e6b79c239351ebeef85647bafdab18a;hpb=871db638f23867006b4b7ec941a92b6709ccab9e;p=rust-lightning 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