mirror of
https://github.com/Comfy-Org/comfy-complete.git
synced 2026-11-04 23:37:26 +00:00
[PR #8] docs: promote CLAUDE.md to AGENTS.md and add Claude Code shim #7
Labels
No labels
pull-request
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
Comfy-Org/comfy-complete#7
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
📋 Pull Request Information
Original PR: https://github.com/Comfy-Org/comfy-complete/pull/8
Author: @mattmillerai
Created: 9/16/2026
Status: 🔄 Open
Base:
main← Head:matt/be-3569-promote-claude-md-to-agents-md📝 Commits (2)
2f96fe2docs: promote CLAUDE.md to AGENTS.md and add Claude Code shim79a0261docs: scope add-node scripts to node-pack entry validation in AGENTS.md📊 Changes
2 files changed (+68 additions, -66 deletions)
View changed files
➕
AGENTS.md(+66 -0)📝
CLAUDE.md(+2 -66)📄 Description
ELI-5
Different AI coding tools look for their instructions in different filenames. This repo only had a
CLAUDE.md, so only Claude Code saw the house rules — Codex, Cursor, and Amp got nothing. The fix: renameCLAUDE.md→AGENTS.md(the filename every modern agent tool reads), and leave a tinyCLAUDE.mdbehind that just says "read AGENTS.md." Now every agent gets the same guidance, and the content lives in one place.What changed
git mv CLAUDE.md AGENTS.md— the guidance content is carried over unchanged (it was already generic, tool-neutral agent/contributor guidance), except one review-driven clarification: the "Scripts (not agents)" intro now scopesscripts/add-node/to node-pack entry validation, since test-workflow validation/coverage live inscripts/validate_test_workflows.py/scripts/check_test_coverage.py.CLAUDE.mdis now a shim that importsAGENTS.mdvia@AGENTS.md— Claude Code reads onlyCLAUDE.mdand does not fall back toAGENTS.md, so the import keeps Claude working whileAGENTS.mdis the single source of truth.Why
Aligns this repo with the cross-agent
AGENTS.mdstandard (part of an org-wide instruction-file standardization). Non-Claude agents previously received zero instructions; they now read the same file.Notes / verification limits
CLAUDE.md(repo-wide grep of docs/CI/scripts/tests returned nothing), so the rename breaks no links..cursorrulesand no nested instruction files exist, so no sibling shims were needed.AGENTS.mdis 66 lines (well under the 200-line standard); left untrimmed as the ticket scope was promote-and-shim only.Provenance
python3 scripts/validate_test_workflows.py: 53/53 passed on the current headpython3 scripts/check_test_coverage.py --warn-only: exit 0 on the current headpytest tests/andyamllintnot run locally (change touches only Markdown); CI runs both🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.