docs: add AGENTS.md for AI contributor guidelines#688
Conversation
|
All PRs must reference a prior Discord discussion to ensure community alignment before implementation. Please edit the PR description to include a link like: This PR will be automatically closed in 3 days if the link is not added. |
…tent ci/full-values.yaml, add multi-platform ADR
chaodu-agent
left a comment
There was a problem hiding this comment.
One factual issue in AGENTS.md before merge:
AGENTS.mdsays agent subprocesses only receiveHOME,PATH, and explicit[agent].envkeys. That is no longer true inmain:src/acp/connection.rsalso preservesUSERon Unix, andUSERPROFILE,USERNAME,SystemRoot, andSystemDriveon Windows.- Because this section is documenting the process-environment security boundary, the wording needs to match the implementation exactly; otherwise contributors may make the wrong assumption about what reaches the child process.
Please update the guideline text to reflect the actual preserved baseline vars, or relax it to say that credentials are stripped while a small OS/runtime baseline is retained.
List all baseline env vars passed to child processes: - All platforms: HOME, PATH - Unix: USER - Windows: USERPROFILE, USERNAME, SystemRoot, SystemDrive Caught by 擺渡法師 review.
chaodu-agent
left a comment
There was a problem hiding this comment.
LGTM ✅ — Accurate project guidelines for AI contributors. All findings addressed. Ready for maintainer approval.
Review Summary (四法師)
Baseline Check: AGENTS.md is net-new (does not exist on main).
Fixes applied (3 commits by 超渡法師):
- Added missing src files to architecture map (bot_turns.rs, error_display.rs, setup/)
- Removed non-existent ci/full-values.yaml Helm checklist reference
- Added missing multi-platform-adapters.md ADR reference
- Fixed env_clear security description to match actual implementation (caught by 擺渡法師)
Monk Reviews:
- 覺渡法師: 🟢 LGTM — verified factual accuracy post-fix
- 普渡法師: 🟢 LGTM — architecture map fully validated against main
- 擺渡法師: 🟢 LGTM — blocking env_clear issue resolved
Non-blocking NITs:
- Consider adding Discord Discussion URL to PR description
- Consider adding config-reference.md link in Helm section
Summary
Add
AGENTS.mdto the repo root — a structured guidelines file that Kiro CLI (and other ACP agents) automatically reads into context on every session start.Why
Analysis of the last 100 merged PRs revealed recurring patterns that cost us fix-after-fix cycles:
Since 50+ of our last 100 PRs are from AI agents, this file directly shapes contributor behavior — every guideline prevents a class of bugs.
What's Included
Impact
Agents reading this file will: