@@ -14,6 +14,9 @@ purposes. As such there are repository "maintainers" who are responsible for
14
14
merging pull requests as well as a "lead maintainer" who is responsible for the
15
15
release cycle, overall merging, moderation and appointment of maintainers.
16
16
17
+ Getting Started
18
+ ---------------
19
+
17
20
If you're looking for somewhere to start contributing, check out the
18
21
[ good first issue] ( https://github.com/bitcoin/bitcoin/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 )
19
22
list or participate in a weekly [ Bitcoin Core PR Review Club] ( https://bitcoincore.reviews/ ) meeting.
@@ -22,7 +25,7 @@ Communication Channels
22
25
----------------------
23
26
24
27
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
26
29
with the web client, [ webchat.freenode.net] ( https://webchat.freenode.net/ ) . Chat
27
30
history logs can be found
28
31
on [ http://www.erisian.com.au/bitcoin-core-dev/ ] ( http://www.erisian.com.au/bitcoin-core-dev/ )
@@ -33,7 +36,7 @@ requests.
33
36
34
37
The developer
35
38
[ 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
37
40
a patch set.
38
41
39
42
@@ -53,6 +56,8 @@ To contribute a patch, the workflow is as follows:
53
56
The project coding conventions in the [ developer notes] ( doc/developer-notes.md )
54
57
must be followed.
55
58
59
+ ### Committing Patches
60
+
56
61
In general, [ commits should be atomic] ( https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention )
57
62
and diffs should be easy to read. For this reason, do not mix any formatting
58
63
fixes or code moves with actual code changes.
@@ -76,6 +81,8 @@ about Git.
76
81
- Push changes to your fork
77
82
- Create pull request
78
83
84
+ ### Creating the Pull Request
85
+
79
86
The title of the pull request should be prefixed by the component or area that
80
87
the pull request affects. Valid areas as:
81
88
@@ -100,18 +107,24 @@ Examples:
100
107
qt: Add feed bump button
101
108
log: Fix typo in log message
102
109
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
+
103
117
Note that translations should not be submitted as pull requests. Please see
104
118
[ Translation Process] ( https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md )
105
119
for more information on helping with translations.
106
120
121
+ ### Work in Progress Changes and Requests for Comments
122
+
107
123
If a pull request is not to be considered for merging (yet), please
108
124
prefix the title with [ WIP] or use [ Tasks Lists] ( https://help.github.com/articles/basic-writing-and-formatting-syntax/#task-lists )
109
125
in the body of the pull request to indicate tasks are pending.
110
126
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
115
128
116
129
At this stage, one should expect comments and review from other contributors. You
117
130
can add more commits to your pull request by committing them locally and pushing
0 commit comments