Skip to content

Commit 0dc1002

Browse files
committed
Merge bitcoin/bitcoin#24433: doc: Explain that feedback needs to be addressed
fa694f6 doc: Explain that feedback needs to be addressed (MarcoFalke) fa0819e doc: Move peer-review paragraph to right section (MarcoFalke) fa2b65b doc: Add link to release-process.md in CONTRIBUTING.md (MarcoFalke) Pull request description: Generally, the pull request author is expected to reply to all comments or iterate the code before merge. Of course, it is allowed to reject feedback, but it should not be done by silently ignoring it. Clarify this in the docs. Also, some minor copy edits. ACKs for top commit: michaelfolkson: ACK fa694f6 Sjors: ACK fa694f6 jamesob: ACK bitcoin/bitcoin@fa694f6 prayank23: ACK bitcoin/bitcoin@fa694f6 brunoerg: ACK fa694f6 w0xlt: ACK fa694f6 Tree-SHA512: 339d6f252395664442f4bfb73d839314de8c9b0fdc8900a1c4a67b1cef9c73ecb98c7587a842dd5a36a4a3efbd8270d2162962013893706313f7ef34491db18c
2 parents b00b60e + fa694f6 commit 0dc1002

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ revolves around a meritocracy where contributors earn trust from the developer
1212
community over time. Nevertheless, some hierarchy is necessary for practical
1313
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
15-
release cycle as well as overall merging, moderation and appointment of
16-
maintainers.
15+
[release cycle](/doc/release-process.md) as well as overall merging, moderation
16+
and appointment of maintainers.
1717

1818
Getting Started
1919
---------------
@@ -189,9 +189,14 @@ in the body of the pull request to indicate tasks are pending.
189189

190190
At this stage, one should expect comments and review from other contributors. You
191191
can add more commits to your pull request by committing them locally and pushing
192-
to your fork until you have satisfied all feedback.
192+
to your fork.
193193

194-
Note: Code review is a burdensome but important part of the development process, and as such, certain types of pull requests are rejected. In general, if the **improvements** do not warrant the **review effort** required, the PR has a high chance of being rejected. It is up to the PR author to convince the reviewers that the changes warrant the review effort, and if reviewers are "Concept NACK'ing" the PR, the author may need to present arguments and/or do research backing their suggested changes.
194+
You are expected to reply to any review comments before your pull request is
195+
merged. You may update the code or reject the feedback if you do not agree with
196+
it, but you should express so in a reply. If there is outstanding feedback and
197+
you are not actively working on it, your pull request may be closed.
198+
199+
Please refer to the [peer review](#peer-review) section below for more details.
195200

196201
### Squashing Commits
197202

@@ -322,6 +327,14 @@ maintainers take into account the peer review when determining if there is
322327
consensus to merge a pull request (remember that discussions may have been
323328
spread out over GitHub, mailing list and IRC discussions).
324329

330+
Code review is a burdensome but important part of the development process, and
331+
as such, certain types of pull requests are rejected. In general, if the
332+
**improvements** do not warrant the **review effort** required, the PR has a
333+
high chance of being rejected. It is up to the PR author to convince the
334+
reviewers that the changes warrant the review effort, and if reviewers are
335+
"Concept NACK'ing" the PR, the author may need to present arguments and/or do
336+
research backing their suggested changes.
337+
325338
#### Conceptual Review
326339

327340
A review can be a conceptual review, where the reviewer leaves a comment
@@ -422,11 +435,6 @@ https://github.com/bitcoin/bitcoin/pull/16189).
422435
Also see the [backport.py script](
423436
https://github.com/bitcoin-core/bitcoin-maintainer-tools#backport).
424437

425-
Release Policy
426-
--------------
427-
428-
The project leader is the release manager for each Bitcoin Core release.
429-
430438
Copyright
431439
---------
432440

0 commit comments

Comments
 (0)