Skip to content

Commit 5eed205

Browse files
committed
Change CONTRIBUTING.md to reflect Elements Project process
1 parent 66114fd commit 5eed205

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

CONTRIBUTING.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
Contributing to Bitcoin Core
1+
Contributing to Elements Core
22
============================
33

4-
The Bitcoin Core project operates an open contributor model where anyone is welcome to contribute towards development in the form of peer review, testing and patches. This document explains the practical process and guidelines for contributing.
5-
6-
Firstly in terms of structure, there is no particular concept of “Core developers” in the sense of privileged people. Open source often naturally revolves around meritocracy where longer term contributors gain more trust from the developer community. However, some hierarchy is necessary for practical purposes. As such there are repository “maintainers” who are responsible for merging pull requests as well as a “lead maintainer” who is responsible for the release cycle, overall merging, moderation and appointment of maintainers.
4+
The Elements Core project operates an open contributor model where anyone is welcome to contribute towards development in the form of peer review, testing and patches. This document explains the practical process and guidelines for contributing.
75

6+
In Contrast to Bitcoin Core, this repository is property of Blockstream Inc. which means that acceptance of contributions comes down to one of the privelaged "maintainers" of the repository. These maintainers are responsible for merging pull requests as well as a “lead maintainer” who is responsible for the release cycle, overall merging, moderation and appointment of maintainers. The intention is however to follow a very similar meritocratic model to Bitcoin Core's, meaning that all contributions are welcome, and a history of high-quality contributions will likely pull more weight than otherwise.
87

98
Contributor Workflow
109
--------------------
@@ -81,9 +80,9 @@ Project maintainers aim for a quick turnaround on refactoring pull requests, so
8180
"Decision Making" Process
8281
-------------------------
8382

84-
The following applies to code changes to the Bitcoin Core project (and related projects such as libsecp256k1), and is not to be confused with overall Bitcoin Network Protocol consensus changes.
83+
The following applies to code changes to the Elements Core project (and related projects such as libsecp256k1).
8584

86-
Whether a pull request is merged into Bitcoin Core rests with the project merge maintainers and ultimately the project lead.
85+
Whether a pull request is merged into Elements Core rests with the project merge maintainers and ultimately the project lead.
8786

8887
Maintainers will take into consideration if a patch is in line with the general principles of the project; meets the minimum standards for inclusion; and will judge the general consensus of contributors.
8988

@@ -96,8 +95,7 @@ In general, all pull requests must:
9695
- not break the existing test suite;
9796
- where bugs are fixed, where possible, there should be unit tests demonstrating the bug and also proving the fix. This helps prevent regression.
9897

99-
Patches that change Bitcoin consensus rules are considerably more involved than normal because they affect the entire ecosystem and so must be preceded by extensive mailing list discussions and have a numbered BIP. While each case will be different, one should be prepared to expend more time and effort than for other kinds of patches because of increased peer review and consensus building requirements.
100-
98+
Changes to the consensus ruleset will likely be denied unless it is a direct security issue. In this case the issue should be sent to one of the project maintainers in private using secure communication if possible. Blockstream reserves the right to include additional feature softforks to a currently-running network, and hardforking changes for new networks.
10199

102100
###Peer Review
103101

@@ -115,10 +113,9 @@ Project maintainers reserve the right to weigh the opinions of peer reviewers us
115113

116114
Where a patch set affects consensus critical code, the bar will be set much higher in terms of discussion and peer review requirements, keeping in mind that mistakes could be very costly to the wider community. This includes refactoring of consensus critical code.
117115

118-
Where a patch set proposes to change the Bitcoin consensus, it must have been discussed extensively on the mailing list and IRC, be accompanied by a widely discussed BIP and have a generally widely perceived technical consensus of being a worthwhile change based on the judgement of the maintainers.
119-
116+
Where a patch set proposes to change the Elements consensus, it must have been discussed extensively on the github thread, and receive a larger number of ACKs, including multiple tested ACKs from maintainers.
120117

121118
Release Policy
122119
--------------
123120

124-
The project leader is the release manager for each Bitcoin Core release.
121+
The project leader is the release manager for each Elements Core release.

0 commit comments

Comments
 (0)