chore(ci): generalize PR template Test Plan to Verification#889
Conversation
The 'PR template filled in' check hard-required a non-empty '## Test Plan' section, and the template's scaffolding (cargo-test checkboxes) assumes a code-change PR. Release PRs (version bump + changelog roll), docs-only, and CI-only PRs either failed the check or filled in checkboxes that were not true. - Template: '## Test Plan' becomes a generic '## Verification' section with guidance per PR kind (code / release / docs-CI-chore); the Checklist CHANGELOG line covers the release-roll and not-applicable cases. - Check: section extraction is factored into section_content(), and a new check_section_any() accepts '## Verification' or the legacy '## Test Plan' so in-flight PRs keep passing. - Fixes a latent extraction bug: the old sed '1d;$d' deleted the LAST line of the range positionally, which ate a content line whenever the checked section was the final section of the PR body; the closing header is now removed by pattern. Verified locally by running the check function against four bodies: Verification-as-last-section (passes, previously bitten by the $d bug), legacy Test Plan (passes), comment-placeholder-only (fails), section missing (fails). Closes #888
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the repository's pull request template and associated validation logic to be more flexible. By transitioning from a strict 'Test Plan' requirement to a broader 'Verification' section, the template now provides better guidance for various types of contributions, including releases and documentation, while maintaining robust validation checks. Highlights
Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. The template was rigid and tight, It failed when the code wasn't right. Now Verification is here, To make the process quite clear, And keep all the workflows in light. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the pull request template (.github/pull_request_template.md) by renaming the 'Test Plan' section to 'Verification' with updated validation instructions, and refining the CHANGELOG checklist item. The feedback suggests simplifying the CHANGELOG checklist phrasing to improve readability and align its terminology with the verification categories.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
1 participant
Linked Issue
Closes #888
Summary
The
PR template filled incheck hard-requires a non-empty## Test Plansection, and the template's scaffolding (cargo-test checkboxes) assumes a code-change PR. Release PRs (version bump + changelog roll, e.g. #854), docs-only, and CI-only PRs either fail the check or fill in checkboxes that aren't true. This generalizes the section to## Verificationwhile keeping the legacy name accepted.Changes
## Test Plan→ generic## Verificationwith per-kind guidance (code / release / docs-CI-chore); Checklist CHANGELOG line now covers the release-roll and not-applicable cases.section_content(); newcheck_section_any()accepts## Verificationor legacy## Test Plan, so in-flight PRs keep passing.sed '1d;$d'deleted the range's last line positionally, which ate a content line whenever the checked section was the final section of a PR body. The closing header is now removed by pattern.Verification
Ran the check function locally against four PR bodies:
## Verificationas the final body section with content (passes — previously bitten by the$dbug), legacy## Test Planmid-body (passes), comment-placeholder-only section (fails as intended), section absent (fails as intended). This PR's own body exercises the new check end-to-end, sincepull_requestworkflows run from the merge ref.Checklist
.github/paths)