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

Merge pull request #507 from moneyball/patch-2

Browse source 
Add project tracking and conventions we want to adopt
This commit is contained in:
Matt Corallo 2020-02-29 02:59:34 +00:00 • committed by GitHub
commit ce4de5fb52
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.md
View file

@ -15,12 +15,15 @@ you'll learn.
Communications Channels
-----------------------
Communication about Rust-Lightning happens primarily on #ldk-dev on the [LDK slack](http://www.lightningdevkit.org/),
but also #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.
Major projects are tracked [here](https://github.com/rust-bitcoin/rust-lightning/projects).
Major milestones are tracked [here](https://github.com/rust-bitcoin/rust-lightning/milestones?direction=asc&sort=title&state=open).
Contribution Workflow
---------------------
@ -49,9 +52,15 @@ hestitate to split it into multiple small, focused PRs.
The Minimal Supported Rust Version is 1.22.0 (enforced by our Travis).
Commits should cover both issues fixed and solutions' rationale.
Commits should cover both the issue fixed and the solution's rationale.
These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
To facilitate communication with other contributors, the project is making use of
GitHub's "assignee" field. First check that no one is assigned and then comment
suggesting that you're working on it. If someone is already assigned, don't hesitate
to ask if the assigned party or previous commenters are still working on it if it has
been awhile.
Peer review
-----------
@ -94,6 +103,7 @@ Going further
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)
and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
While there are differences between the projects in terms of context and maturity, many of the suggestions offered apply to this project.
While there are differences between the projects in terms of context and maturity, many
of the suggestions offered apply to this project.
Overall, have fun :)