Add Reviewer Guidance: Comment/Approve/ Request Changes.#639
Conversation
|
|
||
| How to Review a Pull Request | ||
|
|
||
| When reviewing a PR, you can provide feedback, approve the changes, or request updates using GitHub’s standard review options: |
There was a problem hiding this comment.
Would everyone have the permissions to approve or request changes?
|
|
||
| How to Review a Pull Request | ||
|
|
||
| When reviewing a PR, you can provide feedback, approve the changes, or request updates using GitHub’s standard review options: |
There was a problem hiding this comment.
| When reviewing a PR, you can provide feedback, approve the changes, or request updates using GitHub’s standard review options: | |
| When reviewing a PR, you can provide feedback, approve the PR, or request changes using GitHub’s standard review options: |
| Please attach any support files to the issue itself, | ||
| see [Attaching files](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files). | ||
|
|
||
| ### Reviewing Patches |
There was a problem hiding this comment.
Is there a context for these changes? Otherwise it seems like stating the obvious. Is this for engineers who have not worked with Github before?
|
|
||
| How to Review a Pull Request | ||
|
|
||
| When reviewing a PR, you can provide feedback, approve the changes, or request updates using GitHub’s standard review options: |
|
|
||
| Resolving review conversations | ||
|
|
||
| The author may directly resolve minor comments such as nits, formatting adjustments or other trivial issues. |
There was a problem hiding this comment.
This may be confusing as "resolve comment" may mean fix the code, while here this specifically refers to click Resolve button on a comment.
Below it says "resolve the conversation" which is already a bit more specific, but we may want to be very clear.
Also, you may try to rephrase by starting with why, e.g. along the lines of
In order to allow reviewers to remember the context of requested change, do not resolve the conversation, but comment how it was fixed.
then go on to say that minor changes that are accepted as requested can be resolved by the author.
4 participants
No description provided.