Further clean up some comments wrt the peer socket handling API
[rust-lightning] / CONTRIBUTING.md
index 0ae4aedadb38588beedc32f7ee7a183d060d28ba..c54701ddfde83c1fe6dc3334f4c0f32c79334cd9 100644 (file)
@@ -6,17 +6,17 @@ welcome to contribute towards development in the form of peer review, documentat
 testing and patches.
 
 Anyone is invited to contribute without regard to technical experience, "expertise", OSS
-experience, age, or other concern. However, developing cryptocurrencies demand a
-high-level of rigor, adversial thinking, thorough testing and risk-minimization.
-Any bug may cost users real money. That said we deeply welcome people contributing
+experience, age, or other concern. However, the development of cryptocurrencies demands a
+high-level of rigor, adversarial thinking, thorough testing and risk-minimization.
+Any bug may cost users real money. That being said, we deeply welcome people contributing
 for the first time to an open source project or pick up Rust while contributing. Don't be shy,
 you'll learn.
 
 Communications Channels
 -----------------------
 
-Communication about Rust-Lightning happens primarily on #ldk-dev on the [LDK slack](http://www.lightningdevkit.org/)
-or #rust-bitcoin on IRC Freenode.
+Communication about Rust-Lightning happens primarily on #ldk-dev on the [LDK slack](http://www.lightningdevkit.org/),
+but also #rust-bitcoin on IRC Freenode.
 
 Discussion about code base improvements happens in GitHub issues and on pull
 requests.
@@ -45,11 +45,11 @@ must be given to the long term technical debt. Every new features should
 be covered by functional tests.
 
 When refactoring, structure your PR to make it easy to review and don't
-hestitate to split in multiple small, focused PRs.
+hestitate to split it into multiple small, focused PRs.
 
 The Minimal Supported Rust Version is 1.22.0 (enforced by our Travis).
 
-Commit should cover both issues fixed and solutions rationale.
+Commits should cover both issues fixed and solutions' rationale.
 These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
 
 Peer review
@@ -72,22 +72,22 @@ Security
 
 Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites
 helps prevent user loss of funds. If you believe a vulnerability may affect other Lightning
-implementations please inform them.
+implementations, please inform them.
 
 Note that Rust-Lightning is currently considered "pre-production" during this time, there
-is no special handling of security issues. Please simpy open an issue on Github.
+is no special handling of security issues. Please simply open an issue on Github.
 
 Testing
 -------
 
 Related to the security aspect, Rust-Lightning developers take testing
-very seriously. Due to the modular nature of the project writing new functional
+very seriously. Due to the modular nature of the project, writing new functional
 tests is easy and good test coverage of the codebase is an important goal. Refactoring
 the project to enable fine-grained unit testing is also an ongoing effort.
 
-Fuzzing is heavily encouraged: you will find all related fuzzing stuff under `fuzz/`
+Fuzzing is heavily encouraged: you will find all related material under `fuzz/`
 
-Mutation testing is work-in-progess; any contribution there would be warmly welcomed.
+Mutation testing is work-in-progress; any contribution there would be warmly welcomed.
 
 Going further
 -------------