X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=186ae274fdacfcb165e7c0a9227f2837e12778c8;hb=6b2e179bc1fef2f91f84cdce883752162ec41466;hp=241c64208565459a0abf5a5d9818365add6de617;hpb=52121ea97e7723b94fa215b72cf1e6a906c39531;p=rust-lightning diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 241c6420..186ae274 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,31 @@ 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 culture before investing an asymmetric number of hours on +development compared to your merged work. + +Browsing through the [meeting minutes](https://github.com/rust-bitcoin/rust-lightning/wiki/Meetings) +is a good first step. You will learn who is working on what, how releases are drafted, what are the +pending tasks to deliver, where you can contribute review bandwidth, etc. + +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. + +Also, getting familiar with the [glossary](GLOSSARY.md) will streamline discussions with regular contributors. + Contribution Workflow ---------------------