Skip to content

docs: improve agent guidance on issue references in regression tests#3146

Merged
opieter-aws merged 1 commit into
strands-agents:mainfrom
opieter-aws:opieter-aws/agents-md-issue-references
Jul 9, 2026
Merged

docs: improve agent guidance on issue references in regression tests#3146
opieter-aws merged 1 commit into
strands-agents:mainfrom
opieter-aws:opieter-aws/agents-md-issue-references

Conversation

@opieter-aws

@opieter-aws opieter-aws commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

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.md is narrowed, and the per-SDK TESTING.md files are brought in line. The TypeScript TESTING.md had no "Comments in Tests" section at all — only the Python guide did — so agents working in strands-ts never 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); no site/ documentation changes are needed.

Type of Change

Documentation update

Testing

  • I ran hatch run prepare

Checklist

  • I have read the CONTRIBUTING document
  • I have reviewed and understand every line of code in this PR, including any generated by AI tools, and I can explain why it works
  • My change is focused and reasonably small; I have split unrelated work into separate PRs
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@opieter-aws opieter-aws force-pushed the opieter-aws/agents-md-issue-references branch from 09d6dd8 to 06ec7bf Compare July 9, 2026 13:14
@github-actions github-actions Bot added the documentation Documentation changes, improvements, additions, content updates, site improvements, examples, guides label Jul 9, 2026
@opieter-aws opieter-aws force-pushed the opieter-aws/agents-md-issue-references branch from 06ec7bf to 9a696dc Compare July 9, 2026 13:23
@opieter-aws opieter-aws marked this pull request as ready for review July 9, 2026 13:26
@opieter-aws opieter-aws requested a review from a team as a code owner July 9, 2026 13:26
@opieter-aws opieter-aws requested a review from liramon2 July 9, 2026 13:26
Comment thread strands-ts/docs/TESTING.md
Comment thread AGENTS.md
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
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
  • Formatting: A stray blank line was added inside the tight bullet list in AGENTS.md, breaking list consistency (inline comment).
  • Cross-file parity: The TS guide says "issue/PR reference" while the canonical AGENTS.md and Python guide say only "issue reference"; worth aligning given this PR's parity goal (inline comment).

Nice catch closing the gap where strands-ts had no "Comments in Tests" section at all.

@opieter-aws opieter-aws enabled auto-merge (squash) July 9, 2026 13:31
@opieter-aws opieter-aws merged commit 6993ea3 into strands-agents:main Jul 9, 2026
27 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes, improvements, additions, content updates, site improvements, examples, guides size/xs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants