doc: Add headings to CONTRIBUTING.md

This makes it possible to link and refer to subsections

Also, minor clarifications
pull/19072/head
MarcoFalke 5 years ago
parent fab893e0ca
commit 100000d1b2
No known key found for this signature in database
GPG Key ID: CE2B75697E69A548

@ -14,6 +14,9 @@ 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 merging pull requests as well as a "lead maintainer" who is responsible for the
release cycle, overall merging, moderation and appointment of maintainers. release cycle, overall merging, moderation and appointment of maintainers.
Getting Started
---------------
If you're looking for somewhere to start contributing, check out the If you're looking for somewhere to start contributing, check out the
[good first issue](https://github.com/bitcoin/bitcoin/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) [good first issue](https://github.com/bitcoin/bitcoin/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
list or participate in a weekly [Bitcoin Core PR Review Club](https://bitcoincore.reviews/) meeting. list or participate in a weekly [Bitcoin Core PR Review Club](https://bitcoincore.reviews/) meeting.
@ -22,7 +25,7 @@ Communication Channels
---------------------- ----------------------
Most communication about Bitcoin Core development happens on IRC, in the Most communication about Bitcoin Core development happens on IRC, in the
#bitcoin-core-dev channel on Freenode. The easiest way to participate on IRC is `#bitcoin-core-dev` channel on Freenode. The easiest way to participate on IRC is
with the web client, [webchat.freenode.net](https://webchat.freenode.net/). Chat with the web client, [webchat.freenode.net](https://webchat.freenode.net/). Chat
history logs can be found history logs can be found
on [http://www.erisian.com.au/bitcoin-core-dev/](http://www.erisian.com.au/bitcoin-core-dev/) on [http://www.erisian.com.au/bitcoin-core-dev/](http://www.erisian.com.au/bitcoin-core-dev/)
@ -33,7 +36,7 @@ requests.
The developer The developer
[mailing list](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev) [mailing list](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev)
should be used to discuss complicated or controversial changes before working on should be used to discuss complicated or controversial consensus or P2P protocol changes before working on
a patch set. a patch set.
@ -53,6 +56,8 @@ To contribute a patch, the workflow is as follows:
The project coding conventions in the [developer notes](doc/developer-notes.md) The project coding conventions in the [developer notes](doc/developer-notes.md)
must be followed. must be followed.
### Committing Patches
In general, [commits should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention) 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 and diffs should be easy to read. For this reason, do not mix any formatting
fixes or code moves with actual code changes. fixes or code moves with actual code changes.
@ -76,6 +81,8 @@ about Git.
- Push changes to your fork - Push changes to your fork
- Create pull request - Create pull request
### Creating the Pull Request
The title of the pull request should be prefixed by the component or area that The title of the pull request should be prefixed by the component or area that
the pull request affects. Valid areas as: the pull request affects. Valid areas as:
@ -100,18 +107,24 @@ Examples:
qt: Add feed bump button qt: Add feed bump button
log: Fix typo in log message log: Fix typo in log message
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).
### Translation changes
Note that translations should not be submitted as pull requests. Please see Note that translations should not be submitted as pull requests. Please see
[Translation Process](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md) [Translation Process](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md)
for more information on helping with translations. for more information on helping with translations.
### Work in Progress Changes and Requests for Comments
If a pull request is not to be considered for merging (yet), please If a pull request is 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) 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. in the body of the pull request to indicate tasks are pending.
The body of the pull request should contain enough description about what the ### Address Feedback
patch does together with any justification/reasoning. You should include
references to any discussions (for example other tickets or mailing list
discussions).
At this stage, one should expect comments and review from other contributors. You 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 can add more commits to your pull request by committing them locally and pushing

Loading…
Cancel
Save