Clarify the optional sections in the global PR template#8
Merged
DougReeder merged 1 commit intomainfrom Feb 19, 2026
Merged
Conversation
What: Prefixes the optional section descriptions in pull_request_template.md with "OPTIONAL — " and provides more details on what the sections should be used for as well as what to do if they aren't applicable to the PR. Why: The observed use of these sections has been inconsistent and not entirely aligned with their original intent. Note: Having submitters put "None" or "N/A" in sections, rather than leaving them blank or removing them (except potentially for the "Examples" section), ensures that the reviewer will know they haven't been missed or deleted accidentally, or that something else hasn't gone wrong.
DougReeder
approved these changes
Feb 11, 2026
Member
DougReeder
left a comment
DougReeder
left a comment
There was a problem hiding this comment.
To me, they seem a trifle wordy, but let's do this and see how it works out.
|
LGTM. Especially like the alternatives explanation as it really helps me. |
Member
Author
|
Excellent! Thank you. Let's go with merging it then. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What?
Prefixes the optional section descriptions in pull_request_template.md with "OPTIONAL — " and provides more details on what the sections should be used for as well as what to do if they aren't applicable to the PR.
Why?
The observed use of these sections has been inconsistent and not entirely aligned with their original intent.
Examples
N/A
How to test
Documentation of functionality
No functionality has changed, so no documentation update is needed.
Limitations
None.
Alternative implementations considered
Adding more comprehensive examples on what should go in these sections to the pull request guidelines in the policies-procedures-guidelines repo was considered (and will probably be done eventually in addition to this), but people won't always have the pull request guidelines open when making pull requests, while this gets the information right where they need it.
Open questions
Additional details or related context
Having submitters put "None" or "N/A" in sections, rather than leaving them blank or removing them (except potentially for the "Examples" section), ensures that the reviewer will know they haven't been missed or deleted accidentally, or that something else hasn't gone wrong.
This PR came about as a result of discussions at the 2026-02-10 Dev Meetup. Notes - Hubs Dev Meetup Google Doc
Discussion welcome.