chore: simplify and consolidate the org PR template#10
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the org-default pull request template to reduce rendered “filler” while keeping author guidance available in the edit view via HTML comments.
Changes:
- Consolidates “Proposed Changes” + “Reason for Changes” into a single Summary section.
- Updates the Resolves section guidance to accept GitHub issues, Jira tickets, or N/A.
- Renames Test Coverage to Testing and expands guidance to include manual verification and OS/browser coverage for user-visible changes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Replace the four-section template (Proposed Changes / Resolves / Reason for Changes / Test Coverage) with three sections: Summary (what + why), Resolves, and Testing. Merging the what/why split removes a section that was valuable for large changes but redundant for small ones. Guidance moves into HTML comments so it does not linger in the rendered description, and headings are peers (all h2). Resolves now explicitly accommodates GitHub issues, Jira tickets, and N/A, and its example uses the fully qualified org/repo#123 form (per AGENTS.md) rather than a bare reference, which is ambiguous across forks. Testing replaces Test Coverage (broader than added tests) and prompts for OS and browser coverage when a change is user-visible. This is the org-wide default inherited by repos without their own template.
cwillisf
force-pushed
the
chore/consolidate-pr-template
branch
from
ec7b283 to
09fbe47
Compare
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 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.
Summary
Replace the four-section org default PR template with three sections: Summary (what + why), Resolves, and Testing.
The old template split "Proposed Changes" from "Reason for Changes" — useful for a large change, awkward filler for a small one. Merging them into Summary keeps the prompt for the why without forcing an empty section. Other changes: guidance moves into HTML comments so it doesn't linger in the rendered description; headings are now peers (all
##) rather than a mixed#/##hierarchy;Resolvesexplicitly accepts GitHub issues, Jira tickets, or N/A; andTest CoveragebecomesTesting(broader than just added tests) with a prompt for OS + browser coverage on user-visible changes.(This PR's own description uses the new template, as a demo.)
Resolves
N/A — no associated issue. Part of an effort to consolidate PR templates across the org so most repos inherit one well-maintained default instead of drifting per-repo copies. An audit of all ~105 org repos found 16 with their own template: ~12 are near-identical generic variants, and only 3 have genuinely repo-specific needs (
scratch-l10n,scratch-platform,scratchjr-webapp, which keep theirs). Once this lands, the generic copies will be deleted so they inherit this default.Testing
No code change — Markdown only. Verified the rendered preview and confirmed the HTML-comment guidance is hidden in the rendered view. Not user-facing, so no browser coverage applies.