docs(agents): adopt AGENTS.md as canonical AI brief; restructure into TOC + sub-files - #247
Merged
Merged
Conversation
… TOC + sub-files Closes #236. The previous CLAUDE.md was already 95% tool-neutral content (project overview, stack, conventions, semver policy, etc.) with only two Claude-specific lines. Promoting it to AGENTS.md at the repo root and splitting the deeper sections into docs/agents/ sub-files so: - Any AI tool that supports the AGENTS.md convention (Codex, Aider, Cursor with .mdc rules pointing here, future tools) finds the brief by default - Claude Code keeps reading via CLAUDE.md, which is now a 2-line pointer that uses Claude Code's @./AGENTS.md import syntax - GitHub Copilot gets .github/copilot-instructions.md as a thin pointer with the top conventions inlined and a URL to AGENTS.md for the full brief (Copilot has no import syntax) - The "every session" brief (AGENTS.md) stays short and scannable; deeper procedural content (repository layout, release-and-versioning including the PR-creation flow, conventions + what-not-to-do + tool-wrapper recipe) is one click away Structure: - AGENTS.md (~70 lines) — project identity, stack, commands, 6 critical rules, TOC of sub-files and existing docs - docs/agents/repository-layout.md — directory structure, project groupings, transition-shim strategy - docs/agents/release-and-versioning.md — branching, semver policy, PR-creation flow (the procedural section reviewers enforce), release pipeline, NuGet first-publish gotcha - docs/agents/conventions.md — conventions to respect, what-not-to-do list, tool-wrapper recipe (consolidated from three sections that belong together) - CLAUDE.md — 5-line pointer using @./AGENTS.md - .github/copilot-instructions.md — thin pointer with top rules + URL Also updates CONTRIBUTING.md and docs/architecture.md to reference AGENTS.md instead of CLAUDE.md. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced Aug 7, 2026
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
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.
Closes #236.
Summary
Why
Per #236: multiple maintainers use multiple AI tools. Each tool reads from a different file (`CLAUDE.md`, `.github/copilot-instructions.md`, `AGENTS.md` for Codex/Aider). The previous `CLAUDE.md` was already 95% tool-neutral content; promoting it to the community-convention `AGENTS.md` location means any tool that supports the convention finds the brief automatically, and the tool-specific files become thin pointers rather than copies.
Structure
What's NOT in this PR
Test plan