Skip to content

chore: add CLAUDE.md bridge so Claude Code loads AGENTS.md #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwillisf merged 1 commit into from
Jun 15, 2026
Merged

chore: add CLAUDE.md bridge so Claude Code loads AGENTS.md #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ This file is a template for `AGENTS.md` files across Scratch repositories. Copy
replace the placeholder sections with repo-specific content. The HTML comments are standing instructions for
whoever adapts the template — they are safe to leave in place.

Claude Code reads `CLAUDE.md`, not `AGENTS.md`. So that it picks up this guide, also add a one-line `CLAUDE.md`
next to this file whose only content is the import directive `@AGENTS.md`. Use a plain import file rather than a
symlink — a committed symlink does not survive Windows checkouts. Other agent tools continue to read `AGENTS.md`
directly, so this bridge adds Claude Code support without duplicating any content.

When adapting this template, consider adding sections for **Repository layout** and any language- or
framework-specific conventions (TypeScript guidelines, React patterns, testing conventions, etc.) that are
non-obvious from the code itself.
Expand Down Expand Up @@ -60,6 +65,7 @@ organization. It provides org-wide GitHub defaults:
- `CONTRIBUTING.AI.md` — Scratch's org-wide policy on AI-assisted development
- `PULL_REQUEST_TEMPLATE.md` — default PR template
- `AGENTS.md` (this file) — template for per-repo agent guides
- `CLAUDE.md` — a one-line import (`@AGENTS.md`) so Claude Code, which reads `CLAUDE.md` rather than `AGENTS.md`, loads this guide

There is no build step and no test suite. Changes here are prose and Markdown only.

Expand Down
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
Loading