chore(docs): canonicalize AI policy in AGENTS.md; CLAUDE.md is a pointer#10
Merged
Merged
Conversation
Other agents (Codex, Gemini, generic AGENTS.md-aware tools) don't read CLAUDE.md. Moving the org-wide AI policy into AGENTS.md makes it visible to every agent, not just Claude. CLAUDE.md becomes a one-line `@AGENTS.md` reference — the same pattern terraform-github and the workspace's other repos already use. Content moved verbatim. Two adjustments to reflect the new home: - Opening line: "This file is the canonical AI-assistant guidance" -> "Canonical AI-assistant guidance" (the file is AGENTS.md now; the phrasing no longer needs the self-reference). - "Repo-level CLAUDE.md files may extend or specialize" -> "Repo-level AGENTS.md files may extend or specialize" (repos that extend org policy do so in their own AGENTS.md, with their CLAUDE.md as `@AGENTS.md`). JacobPEvans/* references in the tables and links are left as-is per the redirect rules in ~/CLAUDE.local.md — they still resolve via GitHub's transfer redirects and shouldn't be mass-rewritten on sight. Verification ------------ - markdownlint-cli2 AGENTS.md CLAUDE.md -> 0 errors Assisted-by: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Move all content from
CLAUDE.mdinto a newAGENTS.md. ReplaceCLAUDE.mdwith@AGENTS.md. Same patternterraform-githuband the rest of the workspace already use.Why: Other agents (Codex, Gemini, generic AGENTS.md-aware tools) don't read
CLAUDE.md. The org-wide AI policy was hidden from them. Canonicalizing inAGENTS.mdmakes it visible to every agent, with Claude pulling it in via the@AGENTS.mdreference.Diff shape
AGENTS.md— new, 106 lines. Verbatim copy of the oldCLAUDE.mdcontent with two small adjustments:"This file is the canonical AI-assistant guidance"→"Canonical AI-assistant guidance"(the file isAGENTS.mdnow; the self-reference is unnecessary)."Repo-level CLAUDE.md files may extend or specialize"→"Repo-level AGENTS.md files may extend or specialize"(repos following the same pattern have their substantive content in their ownAGENTS.md).CLAUDE.md— now three lines (# AI Agents Configuration+ blank +@AGENTS.md). Claude picks up the@AGENTS.mdreference and loads AGENTS.md as context.JacobPEvans/*references in the inheritance tables and links are left as-is per~/CLAUDE.local.md's redirect rules — they resolve via GitHub's transfer redirects and shouldn't be mass-rewritten on sight.Test plan
markdownlint-cli2 AGENTS.md CLAUDE.md→ 0 errors@AGENTS.mdin a new session in this repo (the@import syntax is what other workspace repos use; behavior matchesterraform-github/CLAUDE.md)