Skip to content

Commit 3aa0253

Browse files
authored
Merge pull request #745 from ariard/2020-11-getting-started
Add a Getting Started in CONTRIBUTING.md
2 parents 6882719 + 7e7635d commit 3aa0253

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,25 @@ requests.
2424
Major projects are tracked [here](https://github.com/rust-bitcoin/rust-lightning/projects).
2525
Major milestones are tracked [here](https://github.com/rust-bitcoin/rust-lightning/milestones?direction=asc&sort=title&state=open).
2626

27+
Getting Started
28+
---------------
29+
30+
First and foremost, start small.
31+
32+
This doesn't mean don't be ambitious with the breadth and depth of your contributions but rather
33+
understand the project context and culture before investing an asymmetric number of hours on
34+
development compared to your merged work.
35+
36+
Even if you have an extensive open source background or sound software engineering skills, consider
37+
that the reviewers' comprehension of the code is as much important as technical correctness.
38+
39+
It's very welcome to ask for review, either on IRC or LDK Slack. And also for reviewers, it's nice
40+
to provide timelines when you hope to fulfill the request while bearing in mind for both sides that's
41+
a "soft" commitment.
42+
43+
If you're eager to increase the velocity of the dev process, reviewing other contributors work is
44+
the best you can do while waiting review on yours.
45+
2746
Contribution Workflow
2847
---------------------
2948

0 commit comments

Comments
 (0)