X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=241c64208565459a0abf5a5d9818365add6de617;hb=36e732879ad68b5e13d8a6e33196cb1263f0cf2a;hp=7a0c71f407a912aa31ef8a8fdbcae8fef911dc81;hpb=f1c7fd2ab9b4df5f4b7cad855501d1178b2eb1c6;p=rust-lightning diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a0c71f4..241c6420 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,8 @@ be covered by functional tests. When refactoring, structure your PR to make it easy to review and don't hestitate to split it into multiple small, focused PRs. -The Minimal Supported Rust Version is 1.22.0 (enforced by our Travis). +The Minimal Supported Rust Version is 1.30.0 (enforced by our Travis and +GitHub Actions). Commits should cover both the issue fixed and the solution's rationale. These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind. @@ -76,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 -------- @@ -98,6 +111,17 @@ Fuzzing is heavily encouraged: you will find all related material under `fuzz/` Mutation testing is work-in-progress; any contribution there would be warmly welcomed. +C/C++ Bindings +-------------- + +You can learn more about the C/C++ bindings that are made available by reading the +[C/C++ Bindings README](lightning-c-bindings/README.md). If you are not using the C/C++ bindings, +you likely don't need to worry about them, and during their early experimental phase we are not +requiring that pull requests keep the bindings up to date (and, thus, pass the bindings_check CI +run). If you wish to ensure your PR passes the bindings generation phase, you should run the +`genbindings.sh` script in the top of the directory tree to generate, build, and test C bindings on +your local system. + Going further -------------