PR Template: update header text to be 'notes to reviewer' #12131
Conversation
This file contains 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Notes to reviewer
The "notes to reviewer" text seems a bit better compared to "Change Summary & Additional Notes"
For single-commit PRs, there is already a change summary present between the commit title & comment which are auto-filled in by the PR. For these kinds of PRs, a section titled "change summary" redundant. At worst, this can be confusing and lead to a practice where less details are put in the commit comment and more detail are put in the "change summary".
Thus, "notes to reviewer" seems better as it is more explicit that these are comments intended only for the reviewers & not the commit history.