Skip to content

Commit 039ffee

Browse files
author
Antoine Riard
committed
Add a Getting Started
Fix by Steve Lee <[email protected]>
1 parent 9c7c3b9 commit 039ffee

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,26 @@ 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 code comprehension by the other set of regular contributors is as much important as its
38+
technical correctness.
39+
40+
It's very welcome to ask for review, either on IRC or LDK Slack. And also for reviewers, it's nice
41+
to provide timelines when you hope to fulfill the request while bearing in mind for both sides that's
42+
a "soft" commitment.
43+
44+
If you're eager to increase the velocity of the dev process, reviewing other contributors work is
45+
the best you can do while waiting review on yours.
46+
2747
Contribution Workflow
2848
---------------------
2949

0 commit comments

Comments
 (0)