[bindings] Support mapping slices which contain tuples (with refs)
[rust-lightning] / CONTRIBUTING.md
index 3e77f5d25e4222a60df1609291fd49f9f378d100..241c64208565459a0abf5a5d9818365add6de617 100644 (file)
@@ -7,8 +7,8 @@ testing and patches.
 
 Anyone is invited to contribute without regard to technical experience, "expertise", OSS
 experience, age, or other concern. However, the development of cryptocurrencies demands a
-high-level of rigor, adversial thinking, thorough testing and risk-minimization.
-Any bug may cost users real money. That said we deeply welcome people contributing
+high-level of rigor, adversarial thinking, thorough testing and risk-minimization.
+Any bug may cost users real money. That being said, we deeply welcome people contributing
 for the first time to an open source project or pick up Rust while contributing. Don't be shy,
 you'll learn.
 
@@ -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
 -------------