Skip to content

docs: adopt AGENTS.md standard, symlink CLAUDE.md to it#13871

Open
glours wants to merge 1 commit into
docker:mainfrom
glours:docs/agents-md
Open

docs: adopt AGENTS.md standard, symlink CLAUDE.md to it#13871
glours wants to merge 1 commit into
docker:mainfrom
glours:docs/agents-md

Conversation

@glours

@glours glours commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

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
image

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>
Copilot AI review requested due to automatic review settings June 23, 2026 16:25
@glours glours requested a review from a team as a code owner June 23, 2026 16:25
@glours glours requested a review from ndeloof June 23, 2026 16:25

@docker-agent docker-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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.

Comment thread AGENTS.md
Comment on lines +42 to +43
- If a user asks you to create an issue on their behalf, prepend the following
line to the issue body:
Comment thread AGENTS.md
@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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