Clarify PR testing guidance - #14272
Merged
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies pull request testing guidance to distinguish observed behavior from expected scenarios.
Changes:
- Requires factual, first-person testing accounts.
- Adds explicit
Not testedguidance. - Updates Given/When/Then examples to past tense.
Show a summary per file
| File | Description |
|---|---|
.github/PULL_REQUEST_TEMPLATE.md |
Clarifies acceptable testing evidence for pull requests. |
Review details
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Balanced
williammartin
marked this pull request as ready for review
August 27, 2026 10:24
williammartin
requested review from
BagToad
and
a balanced review from Copilot
August 27, 2026 10:24
1 task
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
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.
Description
PR testing descriptions can make expected behavior look like behavior the author actually observed. This updates the
How did you test this change?guidance to require factual first-person accounts of performed actions and observed results, while directing authors to writeNot testedwith an explanation when they did not exercise the changed behavior.How did you test this change?
Not tested. This documentation-only change does not alter
ghruntime behavior. I reviewed the final diff and confirmed that it changes only the testing guidance in the pull request template.Key points
The change keeps Given/When/Then available for executed scenarios, changes its example to factual past tense, and explicitly excludes planned, hypothetical, inferred, and expected scenarios from reported testing.
Notes for reviewers
Review the
How did you test this change?guidance in.github/PULL_REQUEST_TEMPLATE.md. PRs #14271 and #14252 provide the motivating context for distinguishing observed behavior from expected behavior.Authorship and follow-up
Who wrote this:
Who answers review comments: