RFC: Add an AGENTS.md to guide AI coding agents #6794
junyeong0619
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Motivation
AI coding agents (Claude Code, Cursor, Copilot, etc.) are increasingly used to open PRs.
Armeria's conventions are well documented for humans in the
developer guide, but there's no
machine-discoverable entry point, so agents routinely miss project-specific rules and
produce noisy PRs:
com.linecorp.armeria.internalpackages must not be referenced from public APIs.requireNonNull(x, "x"),@Nullable(never@Nonnull), etc.The repository already includes agent tooling — a
.claude/plugin/skill directory — soagent usage is clearly part of the workflow. What's missing is the standard entry point that
tells an agent how Armeria wants code written. A standardized
AGENTS.mdfills that gap,improving the quality of agent-generated PRs and reducing reviewer burden.
Proposal
Add a root-level
AGENTS.mdfollowing the vendor-neutral agents.mdconvention. It summarizes build/test commands, code style, and PR conventions, and points
to the developer guide as the canonical source (the guide always wins on conflicts). It is
documentation-only — no behavior or build change.
Note:
CLAUDE.mdis already in.gitignore, soAGENTS.md(read by most agent tools) isthe natural committed source of truth, complementing the existing
.claude/tooling.Contributors can keep a local
CLAUDE.mdsymlink if they wish.Prior art
apache/airflowships anAGENTS.md.valkey-io/valkeyships anAGENTS.md.Scope / non-goals
Open questions
.github/.I have a draft ready and can open the follow-up PR if there's interest.
Beta Was this translation helpful? Give feedback.
All reactions