docs(agents): add high-quality PR guidance to AGENTS.md#258
Merged
Conversation
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.
|
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
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.
Member
Author
|
Thanks — both addressed:
|
|
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.
poshinchen
approved these changes
Jun 11, 2026
1 task
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
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.
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.
Summary
Companion to the human-facing AI guidance (#257). Agents read
AGENTS.md, notCONTRIBUTING.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.mdwith a "Creating a High-Quality PR" section covering:hatch run prepare, self-review the diff, write a why-focused description.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