Skip to content

Commit a86255b

Browse files
committed
Merge #10211: [doc] Contributor fixes & new "finding reviewers" section
3ddd227 [doc] Add blob about finding reviewers. (Kalle Alm) 846dc17 [doc] Wording fixes in CONTRIBUTING.md. (Kalle Alm) Tree-SHA512: 232e6496769f0fba1022da2e9a3add10dcec721e6cc168d552445125849a8c02729a71b7c526bbff30c7428bcdcfdd92b424014fbb6310148392d261408b4044
2 parents 393160c + 3ddd227 commit a86255b

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ fixes or code moves with actual code changes.
3737

3838
Commit messages should be verbose by default consisting of a short subject line
3939
(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 init.cpp") then a single title line is sufficient. Commit messages should be
40+
paragraph(s), unless the title alone is self-explanatory (like "Corrected typo
41+
in init.cpp") in which case a single title line is sufficient. Commit messages should be
4242
helpful to people reading your code in the future, so explain the reasoning for
4343
your decisions. Further explanation [here](http://chris.beams.io/posts/git-commit/).
4444

@@ -225,6 +225,37 @@ discussed extensively on the mailing list and IRC, be accompanied by a widely
225225
discussed BIP and have a generally widely perceived technical consensus of being
226226
a worthwhile change based on the judgement of the maintainers.
227227

228+
### Finding Reviewers
229+
230+
As most reviewers are themselves developers with their own projects, the review
231+
process can be quite lengthy, and some amount of patience is required. If you find
232+
that you've been waiting for a pull request to be given attention for several
233+
months, there may be a number of reasons for this, some of which you can do something
234+
about:
235+
236+
- It may be because of a feature freeze due to an upcoming release. During this time,
237+
only bug fixes are taken into consideration. If your pull request is a new feature,
238+
it will not be prioritized until the release is over. Wait for release.
239+
- It may be because the changes you are suggesting do not appeal to people. Rather than
240+
nits and critique, which require effort and means they care enough to spend time on your
241+
contribution, thundering silence is a good sign of widespread (mild) dislike of a given change
242+
(because people don't assume *others* won't actually like the proposal). Don't take
243+
that personally, though! Instead, take another critical look at what you are suggesting
244+
and see if it: changes too much, is too broad, doesn't adhere to the
245+
[developer notes](doc/developer-notes.md), is dangerous or insecure, is messily written, etc.
246+
Identify and address any of the issues you find. Then ask e.g. on IRC if someone could give
247+
their opinion on the concept itself.
248+
- It may be because your code is too complex for all but a few people. And those people
249+
may not have realized your pull request even exists. A great way to find people who
250+
are qualified and care about the code you are touching is the
251+
[Git Blame feature](https://help.github.com/articles/tracing-changes-in-a-file/). Simply
252+
find the person touching the code you are touching before you and see if you can find
253+
them and give them a nudge. Don't be incessant about the nudging though.
254+
- Finally, if all else fails, ask on IRC or elsewhere for someone to give your pull request
255+
a look. If you think you've been waiting an unreasonably long amount of time (month+) for
256+
no particular reason (few lines changed, etc), this is totally fine. Try to return the favor
257+
when someone else is asking for feedback on their code, and universe balances out.
258+
228259

229260
Release Policy
230261
--------------

0 commit comments

Comments
 (0)