Skip to content

Commit 4f59b8e

Browse files
authored
Merge pull request #499 from moneyball/patch-1
add clarity to the language
2 parents fc03ab1 + 40e722d commit 4f59b8e

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ welcome to contribute towards development in the form of peer review, documentat
66
testing and patches.
77

88
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
1010
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
1212
for the first time to an open source project or pick up Rust while contributing. Don't be shy,
1313
you'll learn.
1414

1515
Communications Channels
1616
-----------------------
1717

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.
2020

2121
Discussion about code base improvements happens in GitHub issues and on pull
2222
requests.
2323

2424
Contribution Workflow
25-
--------------------
25+
---------------------
2626

2727
The codebase is maintained using the "contributor workflow" where everyone
2828
without exception contributes patch proposals using "pull requests". This
@@ -34,7 +34,6 @@ To contribute a patch, the worflow is a as follows:
3434
2. Create topic branch
3535
3. Commit patches
3636

37-
3837
In general commits should be atomic and diffs should be easy to read.
3938
For this reason do not mix any formatting fixes or code moves with
4039
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
4645
be covered by functional tests.
4746

4847
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.
5049

5150
The Minimal Supported Rust Version is 1.22.0 (enforced by our Travis).
5251

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.
5554

5655
Peer review
5756
-----------
@@ -63,38 +62,38 @@ be reviewed first on the conceptual level before focusing on code style or gramm
6362
fixes.
6463

6564
Coding Conventions
66-
------------
65+
------------------
6766

6867
Use tabs. If you want to align lines, use spaces. Any desired alignment should
6968
display fine at any tab-length display setting.
7069

7170
Security
7271
--------
7372

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.
7776

7877
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.
8079

8180
Testing
8281
-------
8382

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
8685
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.
8887

89-
Fuzzing is heavily-encouraged, you will find all related fuzzing stuff under `fuzz/`
88+
Fuzzing is heavily encouraged: you will find all related material under `fuzz/`
9089

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.
9291

9392
Going further
9493
-------------
9594

9695
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)
9796
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.
9998

10099
Overall, have fun :)

0 commit comments

Comments
 (0)