Skip to content

Commit ce4de5f

Browse files
authored
Merge pull request #507 from moneyball/patch-2
Add project tracking and conventions we want to adopt
2 parents b06dfda + 0c5e351 commit ce4de5f

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,15 @@ you'll learn.
1515
Communications Channels
1616
-----------------------
1717

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.
18+
Communication about Rust-Lightning happens primarily on #ldk-dev on the
19+
[LDK slack](http://www.lightningdevkit.org/), but also #rust-bitcoin on IRC Freenode.
2020

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

24+
Major projects are tracked [here](https://github.com/rust-bitcoin/rust-lightning/projects).
25+
Major milestones are tracked [here](https://github.com/rust-bitcoin/rust-lightning/milestones?direction=asc&sort=title&state=open).
26+
2427
Contribution Workflow
2528
---------------------
2629

@@ -49,9 +52,15 @@ hestitate to split it into multiple small, focused PRs.
4952

5053
The Minimal Supported Rust Version is 1.22.0 (enforced by our Travis).
5154

52-
Commits should cover both issues fixed and solutions' rationale.
55+
Commits should cover both the issue fixed and the solution's rationale.
5356
These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
5457

58+
To facilitate communication with other contributors, the project is making use of
59+
GitHub's "assignee" field. First check that no one is assigned and then comment
60+
suggesting that you're working on it. If someone is already assigned, don't hesitate
61+
to ask if the assigned party or previous commenters are still working on it if it has
62+
been awhile.
63+
5564
Peer review
5665
-----------
5766

@@ -94,6 +103,7 @@ Going further
94103

95104
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)
96105
and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
97-
While there are differences between the projects in terms of context and maturity, many of the suggestions offered apply to this project.
106+
While there are differences between the projects in terms of context and maturity, many
107+
of the suggestions offered apply to this project.
98108

99109
Overall, have fun :)

0 commit comments

Comments
 (0)