Skip to content

docs: add AGENTS.md with CLAUDE.md symlink - #393

Open
H4ad wants to merge 1 commit into
mainfrom
chore/agents-md
Open

H4ad wants to merge 1 commit into
mainfrom
chore/agents-md

Conversation

@H4ad

@H4ad H4ad commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

What

Adds AGENTS.md at the repo root: the working directives coding agents should follow in this repo (repo map, commands, verification steps, and the parts of COMPONENT_GUIDELINES.md an agent gets wrong most often). CLAUDE.md is a symlink to it, so Claude Code picks up the same file without a second copy to keep in sync.

The file points at the canonical docs (CONTRIBUTING.md, COMPONENT_GUIDELINES.md, BUILD.md, VISUAL_TESTING.md, RELEASE.md) rather than restating them, and says those win where they disagree.

Why

Agents were re-deriving the same repo conventions every session, and getting the verification commands wrong. One file, read by every agent that supports either name.

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.

1 participant