[doc] Contributor fixes & new "finding reviewers" section #10211

kallewoof commented at 2:12 PM on April 14, 2017: member

I am summarising the suggestions given to me on IRC earlier regarding finding peer reviewers for pull requests.

I am also doing some general wording tweaks while at it.

I am somewhat concerned this is too wordy and maybe shouldn't be in CONTRIBUTING.md but in a separate file (FINDINGPEERREVIEWERS.md doesn't really float my boat). Feedback welcome. This was one of the biggest frustrations I had when I started out, and I think it's worth some space somewhere.

[doc] Wording fixes in CONTRIBUTING.md. 846dc179bc

TheBlueMatt commented at 9:32 PM on April 14, 2017: member

Seems reasonable. Should definitely have such a section.

MarcoFalke added the label Docs and Output on Apr 14, 2017

MarcoFalke commented at 9:18 AM on April 16, 2017: member

ACK

in CONTRIBUTING.md:238 in 186540ff90 outdated

 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 reports are taken into consideration. If your pull request is a new feature,
 238 | +    it will be disregarded until the release is over. Wait for release.

laanwj commented at 1:14 PM on April 17, 2017:

I think 'disregarded' is too strong here. It will be delayed for merge, but there's no rule preventing e.g. discussion or people from testing it.

kallewoof commented at 1:31 PM on April 17, 2017:

Makes sense. Changing to "will not be prioritized".

in CONTRIBUTING.md:237 in 186540ff90 outdated

 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 reports are taken into consideration. If your pull request is a new feature,

laanwj commented at 1:14 PM on April 17, 2017:

s/bug reports/bug fixes ?

in CONTRIBUTING.md:250 in 186540ff90 outdated

 245 | +    is dangerous or insecure, is messily written, etc. Identify and address any of the
 246 | +    issues you find. Then ask e.g. on IRC if someone could give their opinion on the concept
 247 | +    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 [Git Blame feature](https://help.github.com/articles/tracing-changes-in-a-file/). Simply

laanwj commented at 1:18 PM on April 17, 2017:

Good suggestion.

It looks like github also provides reviewer suggestions based on who touched the code before (see e.g. #10202, or any pull that hasn't got any reviewers yet)

kallewoof commented at 1:32 PM on April 17, 2017:

That may be for members only. I don't see any suggestions on that PR but I've seen suggestions on PR's on repos to which I have merge access.

laanwj commented at 1:23 PM on April 17, 2017: member

Looks good to me

[doc] Add blob about finding reviewers. 3ddd227c2f

kallewoof force-pushed on Apr 17, 2017

kallewoof commented at 1:50 PM on April 17, 2017: member

Addressed issues pointed out by @laanwj. If anyone has any other improvements they'd like to see do let me know!

paveljanik commented at 6:38 PM on April 17, 2017: contributor

ACK https://github.com/bitcoin/bitcoin/pull/10211/commits/3ddd227c2f248476ce1689feb98f2532ea95ec91

Nice addition, thank you!

laanwj merged this on Apr 18, 2017

laanwj closed this on Apr 18, 2017

laanwj referenced this in commit a86255b116 on Apr 18, 2017

kallewoof deleted the branch on Apr 18, 2017

PastaPastaPasta referenced this in commit 6802fcc238 on May 10, 2019

PastaPastaPasta referenced this in commit 8eb7a633a8 on May 15, 2019

PastaPastaPasta referenced this in commit 383d1819a9 on May 20, 2019

PastaPastaPasta referenced this in commit 6b9e2f15c1 on May 21, 2019

barrystyle referenced this in commit aeaa0a7cdc on Jan 22, 2020

DrahtBot locked this on Sep 8, 2021