Skip to content

Commit 100000d

Browse files
author
MarcoFalke
committed
doc: Add headings to CONTRIBUTING.md
This makes it possible to link and refer to subsections Also, minor clarifications
1 parent fab893e commit 100000d

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ purposes. As such there are repository "maintainers" who are responsible for
1414
merging pull requests as well as a "lead maintainer" who is responsible for the
1515
release cycle, overall merging, moderation and appointment of maintainers.
1616

17+
Getting Started
18+
---------------
19+
1720
If you're looking for somewhere to start contributing, check out the
1821
[good first issue](https://github.com/bitcoin/bitcoin/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
1922
list or participate in a weekly [Bitcoin Core PR Review Club](https://bitcoincore.reviews/) meeting.
@@ -22,7 +25,7 @@ Communication Channels
2225
----------------------
2326

2427
Most communication about Bitcoin Core development happens on IRC, in the
25-
#bitcoin-core-dev channel on Freenode. The easiest way to participate on IRC is
28+
`#bitcoin-core-dev` channel on Freenode. The easiest way to participate on IRC is
2629
with the web client, [webchat.freenode.net](https://webchat.freenode.net/). Chat
2730
history logs can be found
2831
on [http://www.erisian.com.au/bitcoin-core-dev/](http://www.erisian.com.au/bitcoin-core-dev/)
@@ -33,7 +36,7 @@ requests.
3336

3437
The developer
3538
[mailing list](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev)
36-
should be used to discuss complicated or controversial changes before working on
39+
should be used to discuss complicated or controversial consensus or P2P protocol changes before working on
3740
a patch set.
3841

3942

@@ -53,6 +56,8 @@ To contribute a patch, the workflow is as follows:
5356
The project coding conventions in the [developer notes](doc/developer-notes.md)
5457
must be followed.
5558

59+
### Committing Patches
60+
5661
In general, [commits should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention)
5762
and diffs should be easy to read. For this reason, do not mix any formatting
5863
fixes or code moves with actual code changes.
@@ -76,6 +81,8 @@ about Git.
7681
- Push changes to your fork
7782
- Create pull request
7883

84+
### Creating the Pull Request
85+
7986
The title of the pull request should be prefixed by the component or area that
8087
the pull request affects. Valid areas as:
8188

@@ -100,18 +107,24 @@ Examples:
100107
qt: Add feed bump button
101108
log: Fix typo in log message
102109

110+
The body of the pull request should contain enough description about what the
111+
patch does together with any justification/reasoning. You should include
112+
references to any discussions (for example other tickets or mailing list
113+
discussions).
114+
115+
### Translation changes
116+
103117
Note that translations should not be submitted as pull requests. Please see
104118
[Translation Process](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md)
105119
for more information on helping with translations.
106120

121+
### Work in Progress Changes and Requests for Comments
122+
107123
If a pull request is not to be considered for merging (yet), please
108124
prefix the title with [WIP] or use [Tasks Lists](https://help.github.com/articles/basic-writing-and-formatting-syntax/#task-lists)
109125
in the body of the pull request to indicate tasks are pending.
110126

111-
The body of the pull request should contain enough description about what the
112-
patch does together with any justification/reasoning. You should include
113-
references to any discussions (for example other tickets or mailing list
114-
discussions).
127+
### Address Feedback
115128

116129
At this stage, one should expect comments and review from other contributors. You
117130
can add more commits to your pull request by committing them locally and pushing

0 commit comments

Comments
 (0)