docs: adopt AGENTS.md standard, symlink CLAUDE.md to it#13871
Conversation
Move the project guide to AGENTS.md (the agents.md convention used by Claude Code, Codex, Cursor, etc.) so all coding agents pick it up — not just Claude. Keep CLAUDE.md as a symlink so Claude-specific tooling keeps working unchanged. Add an "Issue and PR Guidelines" section asking AI agents to disclose their involvement when filing PRs or issues on a human's behalf, mirroring the pattern used in ghostty-org/ghostty's AGENTS.md. Signed-off-by: Guillaume Lours <glours@users.noreply.github.com>
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
This is a clean documentation-only PR. The old CLAUDE.md content (Build & Test, Lint, Code Style, Git) is faithfully reproduced in the new AGENTS.md with no omissions. The new "Issue and PR Guidelines" section with AI-agent disclosure instructions is well-formed. CLAUDE.md is correctly re-created as a relative symlink targeting AGENTS.md at the same directory level. No regressions, no bugs, no issues found.
There was a problem hiding this comment.
Pull request overview
This PR introduces an AGENTS.md project guide intended to be picked up by multiple coding agents/tools, and adds explicit “Issue and PR Guidelines” for AI-assisted submissions.
Changes:
- Add
AGENTS.mdwith build/test/lint/code-style guidance for contributors and agents. - Add an “Issue and PR Guidelines” section with disclosure templates for AI-filed issues/PRs.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
What I did
Move the project guide to AGENTS.md (the agents.md convention used by Claude Code, Codex, Cursor, etc.) so all coding agents pick it up, not just Claude. Keep CLAUDE.md as a symlink so Claude-specific tooling keeps working unchanged.
Add an "Issue and PR Guidelines" section asking AI agents to disclose their involvement when filing PRs or issues on a human's behalf, mirroring the pattern used in ghostty-org/ghostty's AGENTS.md.
Related issue
N/A
(not mandatory) A picture of a cute animal, if possible in relation to what you did
