X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=e8a57d85f7f7e8a9cebe857f6011e7c84dee6b6d;hb=c53d8a3596930afa2d75b663013501e8b8fdd838;hp=b270492bf44cbb6e717d07f5699672ea0c694b31;hpb=d5912ec75f0f909172bf37277c10d2e5e8282128;p=rust-lightning diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b270492b..e8a57d85 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,25 @@ requests. Major projects are tracked [here](https://github.com/rust-bitcoin/rust-lightning/projects). Major milestones are tracked [here](https://github.com/rust-bitcoin/rust-lightning/milestones?direction=asc&sort=title&state=open). +Getting Started +--------------- + +First and foremost, start small. + +This doesn't mean don't be ambitious with the breadth and depth of your contributions but rather +understand the project context and culture before investing an asymmetric number of hours on +development compared to your merged work. + +Even if you have an extensive open source background or sound software engineering skills, consider +that the reviewers' comprehension of the code is as much important as technical correctness. + +It's very welcome to ask for review, either on IRC or LDK Slack. And also for reviewers, it's nice +to provide timelines when you hope to fulfill the request while bearing in mind for both sides that's +a "soft" commitment. + +If you're eager to increase the velocity of the dev process, reviewing other contributors work is +the best you can do while waiting review on yours. + Contribution Workflow --------------------- @@ -77,6 +96,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 --------