Skip to content

docs(agents): add high-quality PR guidance to AGENTS.md#258

Merged
yonib05 merged 3 commits into
strands-agents:mainfrom
yonib05:docs/agents-pr-quality
Jun 12, 2026
Merged

docs(agents): add high-quality PR guidance to AGENTS.md#258
yonib05 merged 3 commits into
strands-agents:mainfrom
yonib05:docs/agents-pr-quality

Conversation

@yonib05

@yonib05 yonib05 commented Jun 11, 2026

Copy link
Copy Markdown
Member

Summary

Companion to the human-facing AI guidance (#257). Agents read AGENTS.md, not CONTRIBUTING.md, so this gives them the same quality bar in the file they actually consume.

Changes

Replaces the thin "PR and Commit Conventions" section in AGENTS.md with a "Creating a High-Quality PR" section covering:

  • Quality bar — understand before submitting, keep it small and focused, open an issue first for significant work, don't pad the diff with unrelated changes.
  • Workflow — scope to one concern, follow the repo's existing patterns, add mirrored tests, run hatch run prepare, self-review the diff, write a why-focused description.
  • Commit/title conventions — retained from the previous section.

It explicitly ties back to CONTRIBUTING.md's "Using AI Tools" section and the PR-template checkbox, so the human-facing and agent-facing guidance reinforce each other.

Testing

  • N/A — docs only.

Expand the thin "PR and Commit Conventions" section into a "Creating a
High-Quality PR" section that gives agents the quality bar and a concrete
workflow: scope to one concern, understand the code, run `hatch run
prepare`, self-review the diff, and write a why-focused description. This
mirrors the human-facing AI guidance in CONTRIBUTING.md so agents opening
PRs are held to the same standard.
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
@github-actions

Copy link
Copy Markdown

Assessment: Comment

Clean, well-scoped docs-only change that gives agents the same quality bar as the human-facing guidance in #257. Tone matches the existing voice and tenet #5. Two non-blocking items below.

Review Categories
  • Cross-PR dependency: The new section links to CONTRIBUTING.md#using-ai-tools and quotes a PR-template checkbox, both of which are introduced by the still-open companion PR docs: add AI contribution guidance to CONTRIBUTING and PR template #257. Worth calling out the merge order so the link and quote aren't dangling if this lands first.
  • Internal reference accuracy: One "see ... above" pointer is slightly off — "Things NOT to Do" lives below this section. Minor wording fix.

Nice complement to #257 — keeping the agent-facing and human-facing guidance in sync is the right call.

The workflow step pointed to "Things NOT to Do" as being above when it
appears below this section. Reference the sections by name without a
directional hint.
@yonib05

yonib05 commented Jun 11, 2026

Copy link
Copy Markdown
Member Author

Thanks — both addressed:

@github-actions

Copy link
Copy Markdown

Assessment: Approve

Both review items from the last pass are resolved:

Clean, well-scoped docs change with no remaining blockers — just sequence #257 ahead of this at merge time. LGTM. 🚀

Match the harness-sdk fix: paraphrase the checkbox instead of quoting it
verbatim so AGENTS.md and the PR template can't drift if the wording
changes.
yonib05 added a commit to yonib05/evals-1 that referenced this pull request Jun 12, 2026
…e anchor

The #creating-a-high-quality-pr anchor only resolves once strands-agents#258 lands, and
the CONTRIBUTING#using-ai-tools anchor depends on strands-agents#257. Link plain
CONTRIBUTING.md, which exists on main today, so the reference never
dangles regardless of merge order.
@yonib05 yonib05 merged commit 483c1b7 into strands-agents:main Jun 12, 2026
15 checks passed
yonib05 added a commit that referenced this pull request Jun 12, 2026
* docs(agents): add community and character guidance to AGENTS.md

Add a "Working with the Community" section framing the agent as a guide
(not a gatekeeper or substitute author): help contributors produce changes
they understand, point them to Discord/Discussions, assume good faith, and
talk with people warmly and concisely. Inspired by p5.js's AGENTS.md.

* docs(agents): tighten community section, link quality bar

Trim the community guidance and replace the duplicated "small change /
authorship" sentiment with a link to the Creating a High-Quality PR
section. Concise on purpose — this file is loaded into agent context, so
avoid restating what lives elsewhere.

* docs(agents): point community section at CONTRIBUTING, not a same-file anchor

The #creating-a-high-quality-pr anchor only resolves once #258 lands, and
the CONTRIBUTING#using-ai-tools anchor depends on #257. Link plain
CONTRIBUTING.md, which exists on main today, so the reference never
dangles regardless of merge order.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants