docs: canonicalize AGENTS.md as the agent guide and freshen against code#19
Draft
jack-arturo wants to merge 3 commits into
Draft
docs: canonicalize AGENTS.md as the agent guide and freshen against code#19jack-arturo wants to merge 3 commits into
jack-arturo wants to merge 3 commits into
Conversation
Promote CLAUDE.md's content to AGENTS.md (canonical, read by all agents) and reduce CLAUDE.md to the bare `@AGENTS.md` import. Mechanical only; the freshness pass follows in the next commit. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Generalize intro to coding agents (Claude Code, Cursor, Codex) and note CLAUDE.md is just the @AGENTS.md import - Sync script list/architecture with actual scripts/ (add configure-github-defaults, propagate-templates, describe/render/sync-baseline/validate-sync, lib/, tests/) and real template tree (config/, docs/, manifest/server/CLAUDE/LICENSE templates) - Fix Node.js floor (≥18 → ≥22, engines >=24) and add the real `node --test scripts/tests/*.mjs` test command
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adopts the “single source of truth” convention for agent guidance by making AGENTS.md the canonical agent guide and reducing CLAUDE.md to an @AGENTS.md import, while also updating the new guide’s content to reflect the repository’s current scripts, layout, and workflows.
Changes:
- Replaced the prior full
CLAUDE.mdguidance with a single@AGENTS.mdimport. - Added a new canonical
AGENTS.mdcontaining repository purpose, common commands, architecture, testing, and standards notes. - Refreshed command/script references and repository structure documentation to match current files.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
CLAUDE.md |
Collapses guidance into an @AGENTS.md import so AGENTS.md becomes canonical. |
AGENTS.md |
Introduces the canonical agent guide with updated commands, repo structure, and standards references. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
STANDARDS.md pins @modelcontextprotocol/sdk ^1.25.1, but templates/typescript/package.json.template:51 pins ^1.27.1. Annotate the divergence inline, mirroring the existing Node version note on the line above, so the claim is factual against current code. Co-Authored-By: Claude Opus 4.8 <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
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.
What & why
Adopts the fleet house standard for agent-direction files:
AGENTS.mdis the single source of truth, andCLAUDE.mdis reduced to a one-line@AGENTS.mdimport. Claude Code resolves the import at launch; every other agent (Cursor, Codex, …) readsAGENTS.md's bytes directly. Token-neutral, and it kills the silent drift between near-identical copies.This repo had no prior
AGENTS.md, so there was no duplication to remove — this is adopting the standard (consistency + future-proofing across the fleet) plus a freshness pass against the current code. Reviewers should not hunt for a divergence that never existed.Two commits
docs: adopt house standard— purely mechanical:CLAUDE.md→@AGENTS.md, establish canonicalAGENTS.md, generalize the intro line from "Claude Code" to "coding agents (Claude Code, Cursor, Codex, …)".docs: freshen AGENTS.md against current code— every factual claim re-verified against source, withpath:linecitations.Freshness changes (this is an infra/templates repo — no MCP tool list)
configure-github-defaults.sh,propagate-templates.sh,describe-server.mjs,render-managed-files.mjs,sync-template-baseline.mjs,validate-sync.mjs.config/,docs/,scripts/lib/,scripts/tests/).node --test scripts/tests/*.mjs(24 pass / 0 fail at time of writing).Caveats (noted for awareness — out of scope for this docs PR)
READMEreferences a nonexistentscripts/register-mcp.sh.STANDARDS.mdis internally inconsistent on Node version (≥22 in prose vs>=24inengines).Review note
Automated verification caught mechanical drift only — every tool/script/path/env-var named now exists in code, counts match,
CLAUDE.mdis exactly@AGENTS.md. It does not judge whether the advice is still good or well-emphasized. Please read the diff for judgment. No auto-merge.🤖 Generated with Claude Code