X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=241c64208565459a0abf5a5d9818365add6de617;hb=426c5b227de2c88909c9385f40106f94e745eef4;hp=b270492bf44cbb6e717d07f5699672ea0c694b31;hpb=1276cc72de06a24ab7ce432f4662f2d954f3c1d0;p=rust-lightning diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b270492b..241c6420 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,6 +77,18 @@ Coding Conventions Use tabs. If you want to align lines, use spaces. Any desired alignment should display fine at any tab-length display setting. +Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default linting +[settings](https://rust-lang.github.io/rust-clippy/rust-1.39.0/index.html). +This includes all lint groups except for nursery, pedantic, and cargo in addition to allowing the following lints: +`erasing_op`, `never_loop`, `if_same_then_else`. + +If you use rustup, feel free to lint locally, otherwise you can just push to CI for automated linting. + +```bash +rustup component add clippy +cargo clippy +``` + Security --------