mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-03-03 10:46:48 +01:00
Code Issues Projects Releases Packages Wiki Activity

fixes per arik feedback

Browse source
This commit is contained in:
Steve Lee 2020-02-13 18:43:58 -08:00 • committed by GitHub
parent 2314b0a25a
commit 067dd3be52
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.md
View file

@ -15,8 +15,8 @@ you'll learn.
Communications Channels Communications Channels
----------------------- -----------------------
Communication about Rust-Lightning happens primarily on #ldk-dev on the [LDK slack](http://www.lightningdevkit.org/) Communication about Rust-Lightning happens primarily on #ldk-dev on the [LDK slack](http://www.lightningdevkit.org/),
or #rust-bitcoin on IRC Freenode. but also #rust-bitcoin on IRC Freenode.
Discussion about code base improvements happens in GitHub issues and on pull Discussion about code base improvements happens in GitHub issues and on pull
requests. requests.
@ -45,11 +45,11 @@ must be given to the long term technical debt. Every new features should
be covered by functional tests. be covered by functional tests.
When refactoring, structure your PR to make it easy to review and don't 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). 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. These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
Peer review Peer review
@ -72,22 +72,22 @@ Security
Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites 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 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 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 Testing
------- -------
Related to the security aspect, Rust-Lightning developers take 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 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. 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 Going further
------------- -------------