You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-20Lines changed: 19 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -6,23 +6,23 @@ welcome to contribute towards development in the form of peer review, documentat
6
6
testing and patches.
7
7
8
8
Anyone is invited to contribute without regard to technical experience, "expertise", OSS
9
-
experience, age, or other concern. Though developing cryptocurrencies demand a
9
+
experience, age, or other concern. However, the development of cryptocurrencies demands a
10
10
high-level of rigor, adversial thinking, thorough testing and risk-minimization.
11
-
Any bug may cost users real money. That said we're deeply welcoming people contributing
11
+
Any bug may cost users real money. That said we deeply welcome people contributing
12
12
for the first time to an open source project or pick up Rust while contributing. Don't be shy,
13
13
you'll learn.
14
14
15
15
Communications Channels
16
16
-----------------------
17
17
18
-
Communication about Rust-Lightning happens primarily on #ldk-dev on the LDK slack
19
-
or #rust-bitcoin on IRC Freenode.
18
+
Communication about Rust-Lightning happens primarily on #ldk-dev on the [LDK slack](http://www.lightningdevkit.org/),
19
+
but also #rust-bitcoin on IRC Freenode.
20
20
21
21
Discussion about code base improvements happens in GitHub issues and on pull
22
22
requests.
23
23
24
24
Contribution Workflow
25
-
--------------------
25
+
---------------------
26
26
27
27
The codebase is maintained using the "contributor workflow" where everyone
28
28
without exception contributes patch proposals using "pull requests". This
@@ -34,7 +34,6 @@ To contribute a patch, the worflow is a as follows:
34
34
2. Create topic branch
35
35
3. Commit patches
36
36
37
-
38
37
In general commits should be atomic and diffs should be easy to read.
39
38
For this reason do not mix any formatting fixes or code moves with
40
39
actual code changes. Further, each commit, individually, should compile
@@ -46,12 +45,12 @@ must be given to the long term technical debt. Every new features should
46
45
be covered by functional tests.
47
46
48
47
When refactoring, structure your PR to make it easy to review and don't
49
-
hesitant to split in multiple small, focused PRs.
48
+
hestitate to split it into multiple small, focused PRs.
50
49
51
50
The Minimal Supported Rust Version is 1.22.0 (enforced by our Travis).
52
51
53
-
Commit should expose both issues fixed and solutions rational.
54
-
these[guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
52
+
Commits should cover both issues fixed and solutions' rationale.
53
+
These[guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
55
54
56
55
Peer review
57
56
-----------
@@ -63,38 +62,38 @@ be reviewed first on the conceptual level before focusing on code style or gramm
63
62
fixes.
64
63
65
64
Coding Conventions
66
-
------------
65
+
------------------
67
66
68
67
Use tabs. If you want to align lines, use spaces. Any desired alignment should
69
68
display fine at any tab-length display setting.
70
69
71
70
Security
72
71
--------
73
72
74
-
Security is the primary focus of Rust-Lightning, disclosure of security vulnerabilites
75
-
helps prevent user loss of funds. If you believe vulnerability may effect other Lightning
76
-
implementations please inform them.
73
+
Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites
74
+
helps prevent user loss of funds. If you believe a vulnerability may affect other Lightning
75
+
implementations, please inform them.
77
76
78
77
Note that Rust-Lightning is currently considered "pre-production" during this time, there
79
-
is no special handling of security issues. Please simpy open an issue on Github.
78
+
is no special handling of security issues. Please simply open an issue on Github.
80
79
81
80
Testing
82
81
-------
83
82
84
-
Deeply tied with the security aspect, Rust-Lightning developers take testing
85
-
very seriously. Due to the modular nature of the project writing new functional
83
+
Related to the security aspect, Rust-Lightning developers take testing
84
+
very seriously. Due to the modular nature of the project, writing new functional
86
85
tests is easy and good test coverage of the codebase is an important goal. Refactoring
87
-
the project to enable fine-grained unit testing is also an ongoing work.
86
+
the project to enable fine-grained unit testing is also an ongoing effort.
88
87
89
-
Fuzzing is heavily-encouraged, you will find all related fuzzing stuff under `fuzz/`
88
+
Fuzzing is heavilyencouraged: you will find all related material under `fuzz/`
90
89
91
-
Mutation testing is work-in-progess, any contribution there would be warmly welcomed.
90
+
Mutation testing is work-in-progress; any contribution there would be warmly welcomed.
92
91
93
92
Going further
94
93
-------------
95
94
96
95
You may be interested by Jon Atack guide on [How to review Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-review-bitcoin-core-prs.md)
97
96
and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
98
-
Modulo projects context and diffference of maturity there is a lot to stick to.
97
+
While there are differences between the projects in terms of context and maturity, many of the suggestions offered apply to this project.
0 commit comments