Skip to content

Commit be1d451

Browse files
Will Binnswbnns
authored andcommitted
contributing.md: Fix formatting
This commit contains two changes to CONTRIBUTING.md that: Fix line line lengths. There were several instances where line lengths were well over 80 characters. This commit adjusts them to make them conform to formatting best practices, to stay under 80 characters when possible. Adhere to consist use of quotes. There are a few instances where smart quotes are used (perhaps because it was pasted from a word processor). This commit replaces them with dumb quotes to keep it consistent with the quotation formatting found in the rest of the document.
1 parent 0833894 commit be1d451

File tree

1 file changed

+109
-33
lines changed

1 file changed

+109
-33
lines changed

CONTRIBUTING.md

Lines changed: 109 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,83 @@
11
Contributing to Bitcoin 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.
4+
The Bitcoin Core project operates an open contributor model where anyone is
5+
welcome to contribute towards development in the form of peer review, testing
6+
and patches. This document explains the practical process and guidelines for
7+
contributing.
58

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.
9+
Firstly in terms of structure, there is no particular concept of "Core
10+
developers" in the sense of privileged people. Open source often naturally
11+
revolves around meritocracy where longer term contributors gain more trust from
12+
the developer community. However, some hierarchy is necessary for practical
13+
purposes. As such there are repository "maintainers" who are responsible for
14+
merging pull requests as well as a "lead maintainer" who is responsible for the
15+
release cycle, overall merging, moderation and appointment of maintainers.
716

817

918
Contributor Workflow
1019
--------------------
1120

12-
The codebase is maintained using the “contributor workflow” where everyone without exception contributes patch proposals using “pull requests”. This facilitates social contribution, easy testing and peer review.
21+
The codebase is maintained using the "contributor workflow" where everyone
22+
without exception contributes patch proposals using "pull requests". This
23+
facilitates social contribution, easy testing and peer review.
1324

1425
To contribute a patch, the workflow is as follows:
1526

1627
- Fork repository
1728
- Create topic branch
1829
- Commit patches
1930

20-
The project coding conventions in the [developer notes](doc/developer-notes.md) must be adhered to.
31+
The project coding conventions in the [developer notes](doc/developer-notes.md)
32+
must be adhered to.
2133

22-
In general [commits should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention) and diffs should be easy to read. For this reason do not mix any formatting fixes or code moves with actual code changes.
34+
In general [commits should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention)
35+
and diffs should be easy to read. For this reason do not mix any formatting
36+
fixes or code moves with actual code changes.
2337

24-
Commit messages should be verbose by default consisting of a short subject line (50 chars max), a blank line and detailed explanatory text as separate paragraph(s); unless the title alone is self-explanatory (like "Corrected typo in main.cpp") then a single title line is sufficient. Commit messages should be helpful to people reading your code in the future, so explain the reasoning for your decisions. Further explanation [here](http://chris.beams.io/posts/git-commit/).
38+
Commit messages should be verbose by default consisting of a short subject line
39+
(50 chars max), a blank line and detailed explanatory text as separate
40+
paragraph(s); unless the title alone is self-explanatory (like "Corrected typo
41+
in main.cpp") then a single title line is sufficient. Commit messages should be
42+
helpful to people reading your code in the future, so explain the reasoning for
43+
your decisions. Further explanation [here](http://chris.beams.io/posts/git-commit/).
2544

26-
If a particular commit references another issue, please add the reference, for example `refs #1234`, or `fixes #4321`. Using the `fixes` or `closes` keywords will cause the corresponding issue to be closed when the pull request is merged.
45+
If a particular commit references another issue, please add the reference, for
46+
example `refs #1234`, or `fixes #4321`. Using the `fixes` or `closes` keywords
47+
will cause the corresponding issue to be closed when the pull request is merged.
2748

28-
Please refer to the [Git manual](https://git-scm.com/doc) for more information about Git.
49+
Please refer to the [Git manual](https://git-scm.com/doc) for more information
50+
about Git.
2951

3052
- Push changes to your fork
3153
- Create pull request
3254

33-
The title of the pull request should be prefixed by the component or area that the pull request affects. Examples:
55+
The title of the pull request should be prefixed by the component or area that
56+
the pull request affects. Examples:
3457

3558
Consensus: Add new opcode for BIP-XXXX OP_CHECKAWESOMESIG
3659
Net: Automatically create hidden service, listen on Tor
3760
Qt: Add feed bump button
3861
Trivial: Fix typo in main.cpp
3962

40-
If a pull request is specifically not to be considered for merging (yet) please prefix the title with [WIP] or use [Tasks Lists](https://help.github.com/articles/basic-writing-and-formatting-syntax/#task-lists) in the body of the pull request to indicate tasks are pending.
63+
If a pull request is specifically not to be considered for merging (yet) please
64+
prefix the title with [WIP] or use [Tasks Lists](https://help.github.com/articles/basic-writing-and-formatting-syntax/#task-lists)
65+
in the body of the pull request to indicate tasks are pending.
4166

42-
The body of the pull request should contain enough description about what the patch does together with any justification/reasoning. You should include references to any discussions (for example other tickets or mailing list discussions).
67+
The body of the pull request should contain enough description about what the
68+
patch does together with any justification/reasoning. You should include
69+
references to any discussions (for example other tickets or mailing list
70+
discussions).
4371

44-
At this stage one should expect comments and review from other contributors. You can add more commits to your pull request by committing them locally and pushing to your fork until you have satisfied all feedback.
72+
At this stage one should expect comments and review from other contributors. You
73+
can add more commits to your pull request by committing them locally and pushing
74+
to your fork until you have satisfied all feedback.
4575

4676
Squashing Commits
4777
---------------------------
48-
If your pull request is accepted for merging, you may be asked by a maintainer to squash and or [rebase](https://git-scm.com/docs/git-rebase) your commits before it will be merged. The basic squashing workflow is shown below.
78+
If your pull request is accepted for merging, you may be asked by a maintainer
79+
to squash and or [rebase](https://git-scm.com/docs/git-rebase) your commits
80+
before it will be merged. The basic squashing workflow is shown below.
4981

5082
git checkout your_branch_name
5183
git rebase -i HEAD~n
@@ -55,67 +87,111 @@ If your pull request is accepted for merging, you may be asked by a maintainer t
5587
# save and quit
5688
git push -f # (force push to GitHub)
5789

58-
The length of time required for peer review is unpredictable and will vary from pull request to pull request.
90+
The length of time required for peer review is unpredictable and will vary from
91+
pull request to pull request.
5992

6093

6194
Pull Request Philosophy
6295
-----------------------
6396

64-
Patchsets should always be focused. For example, a pull request could add a feature, fix a bug, or refactor code; but not a mixture. Please also avoid super pull requests which attempt to do too much, are overly large, or overly complex as this makes review difficult.
97+
Patchsets should always be focused. For example, a pull request could add a
98+
feature, fix a bug, or refactor code; but not a mixture. Please also avoid super
99+
pull requests which attempt to do too much, are overly large, or overly complex
100+
as this makes review difficult.
65101

66102

67103
###Features
68104

69-
When adding a new feature, thought must be given to the long term technical debt and maintenance that feature may require after inclusion. Before proposing a new feature that will require maintenance, please consider if you are willing to maintain it (including bug fixing). If features get orphaned with no maintainer in the future, they may be removed by the Repository Maintainer.
105+
When adding a new feature, thought must be given to the long term technical debt
106+
and maintenance that feature may require after inclusion. Before proposing a new
107+
feature that will require maintenance, please consider if you are willing to
108+
maintain it (including bug fixing). If features get orphaned with no maintainer
109+
in the future, they may be removed by the Repository Maintainer.
70110

71111

72112
###Refactoring
73113

74-
Refactoring is a necessary part of any software project's evolution. The following guidelines cover refactoring pull requests for the project.
114+
Refactoring is a necessary part of any software project's evolution. The
115+
following guidelines cover refactoring pull requests for the project.
75116

76-
There are three categories of refactoring, code only moves, code style fixes, code refactoring. In general refactoring pull requests should not mix these three kinds of activity in order to make refactoring pull requests easy to review and uncontroversial. In all cases, refactoring PRs must not change the behaviour of code within the pull request (bugs must be preserved as is).
117+
There are three categories of refactoring, code only moves, code style fixes,
118+
code refactoring. In general refactoring pull requests should not mix these
119+
three kinds of activity in order to make refactoring pull requests easy to
120+
review and uncontroversial. In all cases, refactoring PRs must not change the
121+
behaviour of code within the pull request (bugs must be preserved as is).
77122

78-
Project maintainers aim for a quick turnaround on refactoring pull requests, so where possible keep them short, uncomplex and easy to verify.
123+
Project maintainers aim for a quick turnaround on refactoring pull requests, so
124+
where possible keep them short, uncomplex and easy to verify.
79125

80126

81127
"Decision Making" Process
82128
-------------------------
83129

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.
130+
The following applies to code changes to the Bitcoin Core project (and related
131+
projects such as libsecp256k1), and is not to be confused with overall Bitcoin
132+
Network Protocol consensus changes.
85133

86-
Whether a pull request is merged into Bitcoin Core rests with the project merge maintainers and ultimately the project lead.
134+
Whether a pull request is merged into Bitcoin Core rests with the project merge
135+
maintainers and ultimately the project lead.
87136

88-
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.
137+
Maintainers will take into consideration if a patch is in line with the general
138+
principles of the project; meets the minimum standards for inclusion; and will
139+
judge the general consensus of contributors.
89140

90141
In general, all pull requests must:
91142

92-
- have a clear use case, fix a demonstrable bug or serve the greater good of the project (for example refactoring for modularisation);
143+
- have a clear use case, fix a demonstrable bug or serve the greater good of
144+
the project (for example refactoring for modularisation);
93145
- be well peer reviewed;
94146
- have unit tests and functional tests where appropriate;
95147
- follow code style guidelines;
96148
- not break the existing test suite;
97-
- where bugs are fixed, where possible, there should be unit tests demonstrating the bug and also proving the fix. This helps prevent regression.
149+
- where bugs are fixed, where possible, there should be unit tests
150+
demonstrating the bug and also proving the fix. This helps prevent regression.
98151

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.
152+
Patches that change Bitcoin consensus rules are considerably more involved than
153+
normal because they affect the entire ecosystem and so must be preceded by
154+
extensive mailing list discussions and have a numbered BIP. While each case will
155+
be different, one should be prepared to expend more time and effort than for
156+
other kinds of patches because of increased peer review and consensus building
157+
requirements.
100158

101159

102160
###Peer Review
103161

104-
Anyone may participate in peer review which is expressed by comments in the pull request. Typically reviewers will review the code for obvious errors, as well as test out the patch set and opine on the technical merits of the patch. Project maintainers take into account the peer review when determining if there is consensus to merge a pull request (remember that discussions may have been spread out over github, mailing list and IRC discussions). The following language is used within pull-request comments:
162+
Anyone may participate in peer review which is expressed by comments in the pull
163+
request. Typically reviewers will review the code for obvious errors, as well as
164+
test out the patch set and opine on the technical merits of the patch. Project
165+
maintainers take into account the peer review when determining if there is
166+
consensus to merge a pull request (remember that discussions may have been
167+
spread out over github, mailing list and IRC discussions). The following
168+
language is used within pull-request comments:
105169

106170
- ACK means "I have tested the code and I agree it should be merged";
107-
- NACK means "I disagree this should be merged", and must be accompanied by sound technical justification. NACKs without accompanying reasoning may be disregarded;
108-
- utACK means "I have not tested the code, but I have reviewed it and it looks OK, I agree it can be merged";
171+
- NACK means "I disagree this should be merged", and must be accompanied by
172+
sound technical justification. NACKs without accompanying reasoning may be disregarded;
173+
- utACK means "I have not tested the code, but I have reviewed it and it looks
174+
OK, I agree it can be merged";
109175
- Concept ACK means "I agree in the general principle of this pull request";
110176
- Nit refers to trivial, often non-blocking issues.
111177

112178
Reviewers should include the commit hash which they reviewed in their comments.
113179

114-
Project maintainers reserve the right to weigh the opinions of peer reviewers using common sense judgement and also may weight based on meritocracy: Those that have demonstrated a deeper commitment and understanding towards the project (over time) or have clear domain expertise may naturally have more weight, as one would expect in all walks of life.
115-
116-
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.
117-
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.
180+
Project maintainers reserve the right to weigh the opinions of peer reviewers
181+
using common sense judgement and also may weight based on meritocracy: Those
182+
that have demonstrated a deeper commitment and understanding towards the project
183+
(over time) or have clear domain expertise may naturally have more weight, as
184+
one would expect in all walks of life.
185+
186+
Where a patch set affects consensus critical code, the bar will be set much
187+
higher in terms of discussion and peer review requirements, keeping in mind that
188+
mistakes could be very costly to the wider community. This includes refactoring
189+
of consensus critical code.
190+
191+
Where a patch set proposes to change the Bitcoin consensus, it must have been
192+
discussed extensively on the mailing list and IRC, be accompanied by a widely
193+
discussed BIP and have a generally widely perceived technical consensus of being
194+
a worthwhile change based on the judgement of the maintainers.
119195

120196

121197
Release Policy

0 commit comments

Comments
 (0)