Docs: Add testing guidance to AGENTS.md - #18166
Merged
Merged
Conversation
Generated tests are often problematic. The fix raised in the community sync is to require a plan first: state what behavior needs verifying and why, before any test is written. The remaining rules scope what belongs in a test, like behavior this change adds or modifies, one behavior per method, nothing for unreachable states, and nothing whose failure would not indicate a user-visible regression. --- **AI Disclosure** - Model: Claude Opus 5 - Platform/Tool: GitHub Copilot CLI - Human Oversight: Iteratated multiple times and Fully reviewed - Prompt Summary: Add the test plan requirement and test scope rules raised in a community discussion on AI-generated contributions. Generated-by: GitHub Copilot CLI (Claude Opus 5) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Comment on lines
+142
to
+146
| - Test the behavior in the plan. Coverage is not a target. | ||
| - Test the behavior this change adds or modifies. Don't assert the correctness of components this code merely calls. | ||
| - One behavior per test method. No omnibus tests asserting several unrelated things. | ||
| - Don't add a test whose failure would not indicate a user-visible regression. | ||
| - Don't add tests for unreachable states, or tests that only restate the implementation. |
Collaborator
There was a problem hiding this comment.
This is a good set of instructions. I would add this.
- Do not add excessive comments in tests when the intention is clear from the test method name.
Contributor
Author
There was a problem hiding this comment.
Is this covered by #18167 in a more general way?
- Don't write a comment that restates the method name, the condition, or the next line.
Collaborator
There was a problem hiding this comment.
Then general one works. Thanks.
nastra
approved these changes
Sep 21, 2026
uros-b
approved these changes
Sep 21, 2026
Member
|
Nice addition |
anuragmantri
approved these changes
Sep 21, 2026
Contributor
Author
|
Merged to main. |
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
4 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.
Generated tests are often problematic. The fix raised in the community sync is to require a plan first: state what behavior needs verifying and why, before any test is written.
The remaining rules scope what belongs in a test, like behavior this change adds or modifies, one behavior per method, nothing for unreachable states, and nothing whose failure would not indicate a user-visible regression.
AI Disclosure
Generated-by: GitHub Copilot CLI (Claude Opus 5)