doc: Explain that feedback needs to be addressed #24433
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brunoerg
reviewed
Feb 23, 2022
fad2343 to
fa39841
Compare
shaavan
approved these changes
Feb 24, 2022
There was a problem hiding this comment.
ACK fad2343
Going commit wise:
- Adding a link to “release cycle” documentation and mentioning it at the beginning of documentation removes the need for a separate Release Policy section. Also, a reader would better understand a release cycle and the role of a “lead maintainer” in it.
- I agree that the note in the
Address Feedbacksection better belongs to the Peer Review section. - Removing “until you have satisfied all feedback.” increases the sentence’s brevity. Also, the added paragraph makes the reader understand the need to address the feedback on their PRs. This is an essential point and habit that every new contributor should follow.
fa39841 to
fa694f6
Compare
|
ACK fa694f6 |
ghost
reviewed
Feb 24, 2022
Comment on lines
+196
to
+197
| it, but you should express so in a reply. If there is outstanding feedback and | ||
| you are not actively working on it, your pull request may be closed. |
There was a problem hiding this comment.
Last sentence can be interpreted in different ways and used to close pull requests. I am not sure about this. Do you have any examples or can this be rephrased to make things clear?
There was a problem hiding this comment.
Example: #13360 (comment)
|
ACK fa694f6 |
|
ACK fa694f6 |
brunoerg
approved these changes
Feb 24, 2022
w0xlt
approved these changes
Feb 24, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.