Skip to content

docs: add AI contribution guidance to CONTRIBUTING and PR template#257

Merged
yonib05 merged 1 commit into
strands-agents:mainfrom
yonib05:docs/ai-contribution-guidance
Jun 12, 2026
Merged

docs: add AI contribution guidance to CONTRIBUTING and PR template#257
yonib05 merged 1 commit into
strands-agents:mainfrom
yonib05:docs/ai-contribution-guidance

Conversation

@yonib05

@yonib05 yonib05 commented Jun 11, 2026

Copy link
Copy Markdown
Member

Summary

We've been seeing more AI-generated PRs, and while we welcome AI-assisted contributions, quality has been inconsistent. This adds friendly-but-clear guidance so contributors know the bar.

Changes

  • CONTRIBUTING.md — new "Using AI Tools" section (right before "Contributing via Pull Requests"). It welcomes AI, but asks contributors to understand the code they submit, keep changes small and incremental, and open an issue first for significant work.
  • PR template — two new checklist items:
    • Reviewed and understand every line, including AI-generated code, and can explain why it works
    • Change is focused and reasonably small; unrelated work split into separate PRs

The tone matches our existing voice and tenet #5 ("accessible to humans and agents"): AI is welcome, but the human is the author.

Testing

  • N/A — docs/template only.

Add a "Using AI Tools" section that welcomes AI-assisted contributions
while setting a clear quality bar: contributors must understand the code
they submit, keep changes small and incremental, and open an issue first
for significant work. Add matching PR-template checklist items so the
expectation is visible at submission time.
Comment thread CONTRIBUTING.md
@github-actions

Copy link
Copy Markdown

Assessment: Approve

Clean, focused docs-only change. The new "Using AI Tools" section is well-written, placed logically before "Contributing via Pull Requests," and matches the existing tone and tenet #5 ("accessible to humans and agents"). The two PR-template checklist additions are clear and appropriately scoped.

Review Categories
  • Scope: ~16 lines across two files — small and self-contained. ✅
  • Structure & Placement: New section sits logically in the contributing flow. ✅
  • Tone & Consistency: Friendly, on-voice, consistent markdown formatting. ✅
  • Maintainability: One minor overlap with existing PR guidance (issue-first / keep-changes-focused) — flagged inline as a non-blocking cross-reference suggestion.
  • Testing: N/A (docs/template only), correctly noted in the PR.

Nice addition — this sets a clear, welcoming bar for AI-assisted contributions.

@yonib05

yonib05 commented Jun 11, 2026

Copy link
Copy Markdown
Member Author

Thanks! On the noted overlap with the existing "Contributing via Pull Requests" section (issue-first / keep-changes-focused): that repetition is intentional. The "Using AI Tools" section restates those two points in the specific context of AI-assisted contributions, where they're the most common failure mode, and the existing section keeps them as general PR mechanics. I'd rather the AI guidance stand on its own than send readers hunting for the relevant bullet elsewhere. Happy to add a cross-link if you'd prefer.

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 enabled auto-merge (squash) June 12, 2026 13:51
@yonib05 yonib05 merged commit 977a0d4 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