chore: adopt AGENTS.md as the agent-instruction source of truth (+ CLAUDE.md shim) - #148
Conversation
Rename .cursorrules to AGENTS.md (content unchanged; already valid markdown) and add a root CLAUDE.md shim that imports it, so Claude Code (which reads only CLAUDE.md) and other agent tools share one source. Update a stale in-code reference to the renamed policy file.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Team Run ID: 📒 Files selected for processing (3)
Included review availability: 0 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour. 📝 WalkthroughWalkthroughThe changes centralize instruction references on ChangesInstruction Source Alignment
Suggested reviewers: Priority: ⬇️ Low Merge Risk: ⚪ Minimal · up to The rename and instruction shim do not introduce an actionable current-head risk. 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
ELI-5
This repo told AI coding tools how to write the docs using a file named
.cursorrules— a name only Cursor recognizes. Newer tools (and the widercross-tool standard) look for
AGENTS.mdinstead, and Claude Code looks onlyfor
CLAUDE.md. So this PR renames the rules file toAGENTS.md(the wordsinside are unchanged) and adds a tiny
CLAUDE.mdthat just says "readAGENTS.md." Now every agent reads the same instructions from a standard place,
and nobody has to keep two copies in sync.
What changed
git mv .cursorrules AGENTS.md— content unchanged (it was already plainmarkdown; only a trailing newline was added). 146 lines, well under the
200-line cap.
CLAUDE.mdcontaining exactly the canonical shim (an explanatorycomment plus
@AGENTS.md, which Claude Code resolves relative to the shim'sdirectory).
points at
AGENTS.md(the rename would otherwise leave a dangling reference).Self-review
.cursorrulesgone (rename detected at 99%, only the trailingnewline differs);
AGENTS.mdcontent otherwise unchanged and < 200 lines;CLAUDE.mdpresent with byte-exact canonical shim content; no nestedAGENTS.mdexists, so no nested shim is required.CLAUDE.mdcomment text — it must match the canonicalshim exactly (including the em-dash). Verified byte-for-byte. The
@AGENTS.mdimport resolves relative to the shim's own directory (repo root), which is
where
AGENTS.mdnow lives.comfyui_embedded_docs/docs/**(verified: the format checker'sDOCS_DIRisthat folder), so they do not run against these root/tooling files — not a
silent skip, just out of their declared scope. The edited Python file compiles
(
py_compileclean); the edit is a comment only.Judgment calls
.gitignoreentries (root anddocs-generation/) that ignore.cursorruleswere kept on purpose: with the legacy file removed, theignore rules now serve to keep anyone from re-adding it, which matches the
"no legacy rules file" intent. Removing them was out of scope and would only
invite regressions.
Residual
are all handled, and a repo-wide sweep found no other references to the old
file name.
is referenced by name only and is not reachable from this environment, so its
body was not read; this change follows the org standard as restated in the
work item itself.
Provenance
git mvrename confirmed at 99% similarity;CLAUDE.mdcontentdiffed byte-for-byte against the canonical shim;
python3 -m py_compilecleanon the edited script; repo-wide grep confirms no remaining stale references
outside the intentionally-kept
.gitignorelines.AGENTS.mdand updated one stalein-code comment reference — both minor follow-through on the rename, disclosed
above.