mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-03-15 15:39:09 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add a Getting Started

Browse source 
Fix by Steve Lee <moneyball@users.noreply.github.com>
This commit is contained in:
Antoine Riard 2020-11-02 11:06:36 -05:00
parent 9c7c3b9921
commit 7e7635d559
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CONTRIBUTING.md
View file

@ -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
---------------------