Skip to content

Commit 85e1539

Browse files
ludamadludamad
authored
chore: add AGENTS.md symlinks so Codex picks up CLAUDE.md guidance (#22907)
## Summary Adds a tracked `AGENTS.md` symlink next to every existing `CLAUDE.md` in the repo. `AGENTS.md` is the cross-vendor convention (Codex, Cursor, Aider, Gemini CLI, Jules, Devin, agents.md spec) for surfacing project-level instructions to AI coding tools. Recent Claude Code versions also read `AGENTS.md` as a fallback, so a single canonical name now works for everyone. The 9 `CLAUDE.md` files in this repo (bb, bb/cpp, bb/cpp/pil/vm2, bb/cpp/src/.../vm2, bb/sol, docs, noir-projects/aztec-nr, spartan, yarn-project) are overwhelmingly project guidance — build commands, branch conventions, code style, CI labels — so making them visible to Codex is straight-up useful. ## Approach Symlink (`AGENTS.md` → `CLAUDE.md`) rather than rename, copy, or pointer-file: - One source of truth — no drift, no double maintenance. - Preserves `git blame` and history on the existing `CLAUDE.md` files. - Anything in scripts/docs/team memory referencing `CLAUDE.md` keeps working. - Mirrors the repo's existing tracked-symlink pattern (`barretenberg/.claude/agents -> ../../.claude/agents`, `yarn-project/.claude/agents -> ../../.claude/agents`). - Trivially reversible. Symlinks are stored as git mode `120000` blobs, so they round-trip cleanly on every dev platform that already builds this repo. Full options analysis (including why a pointer file or content duplication don't work): https://gist.github.com/AztecBot/966deaca0b477f8df7bc937275d80c86 ## Files added ``` barretenberg/AGENTS.md -> CLAUDE.md barretenberg/cpp/AGENTS.md -> CLAUDE.md barretenberg/cpp/pil/vm2/AGENTS.md -> CLAUDE.md barretenberg/cpp/src/barretenberg/vm2/AGENTS.md -> CLAUDE.md barretenberg/sol/AGENTS.md -> CLAUDE.md docs/AGENTS.md -> CLAUDE.md noir-projects/aztec-nr/AGENTS.md -> CLAUDE.md spartan/AGENTS.md -> CLAUDE.md yarn-project/AGENTS.md -> CLAUDE.md ``` No content changes; no behavior changes for existing tooling. ClaudeBox log: https://claudebox.work/s/93fee58b2170556e?run=1
2 parents 7c4e47a + 704f775 commit 85e1539

9 files changed

Lines changed: 9 additions & 0 deletions

File tree

‎barretenberg/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

‎barretenberg/cpp/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

‎barretenberg/cpp/pil/vm2/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

‎barretenberg/cpp/src/barretenberg/vm2/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

‎barretenberg/sol/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

‎docs/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

‎noir-projects/aztec-nr/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

‎spartan/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

‎yarn-project/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

0 commit comments

Comments
 (0)