docs: improve agent guidance on issue references in regression tests#3146
Merged
opieter-aws merged 1 commit intoJul 9, 2026
Merged
Conversation
09d6dd8 to
06ec7bf
Compare
06ec7bf to
9a696dc
Compare
Contributor
|
Assessment: Comment Focused, easy-to-follow documentation change. The rule is clearly narrowed — an issue reference belongs only on a regression test for a discovered bug — and the TypeScript parity section is a welcome addition. Two minor points before merge, neither blocking. Review Categories
Nice catch closing the gap where |
pgrayy
approved these changes
Jul 9, 2026
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
Tighten 'comments in tests' guidance so the rule is unambiguous: an issue reference belongs only on a regression test for a discovered bug, and a test written as part of feature development carries none. My agent would add issue guidance to tests for feature development.
The canonical rule in the root
AGENTS.mdis narrowed, and the per-SDKTESTING.mdfiles are brought in line. The TypeScriptTESTING.mdhad no "Comments in Tests" section at all — only the Python guide did — so agents working instrands-tsnever saw this rule in their own testing doc; this adds the parity section.Related Issues
N/A
Documentation PR
This change is entirely to agent-facing guidance files (
AGENTS.md,docs/TESTING.md); nosite/documentation changes are needed.Type of Change
Documentation update
Testing
hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.