[PR #155] [MERGED] docs: add CLAUDE.md shim importing AGENTS.md #154

New issue

Closed

opened 2026-10-31 22:01:51 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:01:51 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-python-sdk/pull/155
Author: @mattmillerai
Created: 9/16/2026
Status: ✅ Merged
Merged: 10/3/2026
Merged by: @mattmillerai

Base: main ← Head: matt/be-3574-claude-md-shim

📝 Commits (1)

2a6fd4b docs: add CLAUDE.md shim importing AGENTS.md

📊 Changes

1 file changed (+2 additions, -0 deletions)

View changed files

➕ CLAUDE.md (+2 -0)

📄 Description

ELI-5

Claude Code reads CLAUDE.md, not AGENTS.md, and does not fall back. This repo
already keeps all agent instructions in AGENTS.md (the cross-tool standard).
This adds a tiny CLAUDE.md that just imports AGENTS.md, so Claude Code picks
up the exact same instructions instead of finding nothing.

What changed

New root CLAUDE.md containing only the canonical shim: an HTML comment
explaining the pattern plus @AGENTS.md (which resolves relative to the shim's
directory).
AGENTS.md is left byte-for-byte unchanged.

Verification

CLAUDE.md matches the canonical shim exactly (verified via cat -A).
AGENTS.md unchanged: git diff origin/main -- AGENTS.md is empty.
public-repo-hygiene gate passes locally
(python3 scripts/check_public_repo_hygiene.py → OK); the shim contains no
ticket-shaped ids, internal links, or repo refs.
The commands AGENTS.md documents were cross-checked against
.github/workflows/ci.yml and match (ruff check ., ruff format --check .,
mypy src, pytest -v, python scripts/check_drift.py). No source, tests,
generated models, or the sdist allowlist are touched, so the test,
codegen-drift, and build-check jobs are unaffected by this doc-only file.

Residual

The org-standard task described authoring AGENTS.md too, but it already
exists on the default branch (197 lines, under the 200-line cap). The audited
"no AGENTS.md" snapshot predates its authoring and is now stale. Per acceptance
("AGENTS.md content unchanged unless told to trim/merge"), it was left intact;
this PR adds only the missing CLAUDE.md shim.
No .cursorrules exists anywhere in the tree (nothing to remove).
No nested AGENTS.md exists, so no nested sibling shims are needed.
The parent epic is named-only in the brief; its body was not fetched and is not
reachable from this sandbox, so it was not exercised.

Provenance

Authored by: agent-work loop
Verified: public-repo-hygiene passed locally; AGENTS.md confirmed
byte-unchanged vs origin/main; CLAUDE.md confirmed to match the canonical
shim exactly; documented commands cross-checked against CI config.
Deviations: AGENTS.md was not authored because it already exists on the
default branch; only the CLAUDE.md shim was added.

Summary by CodeRabbit

Documentation
- Updated contributor guidance to reference shared instructions in AGENTS.md.
- Clarified that ongoing instruction updates should be maintained in AGENTS.md.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-python-sdk/pull/155 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 9/16/2026 **Status:** ✅ Merged **Merged:** 10/3/2026 **Merged by:** [@mattmillerai](https://github.com/mattmillerai) **Base:** `main` ← **Head:** `matt/be-3574-claude-md-shim` --- ### 📝 Commits (1) - [`2a6fd4b`](https://github.com/Comfy-Org/comfy-python-sdk/commit/2a6fd4bd39d167a36bc4be30f9a0673af2dca95c) docs: add CLAUDE.md shim importing AGENTS.md ### 📊 Changes **1 file changed** (+2 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `CLAUDE.md` (+2 -0) </details> ### 📄 Description ## ELI-5 Claude Code reads `CLAUDE.md`, not `AGENTS.md`, and does not fall back. This repo already keeps all agent instructions in `AGENTS.md` (the cross-tool standard). This adds a tiny `CLAUDE.md` that just imports `AGENTS.md`, so Claude Code picks up the exact same instructions instead of finding nothing. ## What changed - New root `CLAUDE.md` containing **only** the canonical shim: an HTML comment explaining the pattern plus `@AGENTS.md` (which resolves relative to the shim's directory). - `AGENTS.md` is left **byte-for-byte unchanged**. ## Verification - `CLAUDE.md` matches the canonical shim exactly (verified via `cat -A`). - `AGENTS.md` unchanged: `git diff origin/main -- AGENTS.md` is empty. - `public-repo-hygiene` gate passes locally (`python3 scripts/check_public_repo_hygiene.py` → `OK`); the shim contains no ticket-shaped ids, internal links, or repo refs. - The commands `AGENTS.md` documents were cross-checked against `.github/workflows/ci.yml` and match (`ruff check .`, `ruff format --check .`, `mypy src`, `pytest -v`, `python scripts/check_drift.py`). No source, tests, generated models, or the sdist allowlist are touched, so the `test`, `codegen-drift`, and `build-check` jobs are unaffected by this doc-only file. ## Residual - The org-standard task described authoring `AGENTS.md` too, but it **already exists** on the default branch (197 lines, under the 200-line cap). The audited "no AGENTS.md" snapshot predates its authoring and is now stale. Per acceptance ("AGENTS.md content unchanged unless told to trim/merge"), it was left intact; this PR adds only the missing `CLAUDE.md` shim. - No `.cursorrules` exists anywhere in the tree (nothing to remove). - No nested `AGENTS.md` exists, so no nested sibling shims are needed. - The parent epic is named-only in the brief; its body was not fetched and is not reachable from this sandbox, so it was not exercised. ## Provenance - **Authored by:** agent-work loop - **Verified:** `public-repo-hygiene` passed locally; `AGENTS.md` confirmed byte-unchanged vs `origin/main`; `CLAUDE.md` confirmed to match the canonical shim exactly; documented commands cross-checked against CI config. - **Deviations:** `AGENTS.md` was not authored because it already exists on the default branch; only the `CLAUDE.md` shim was added.  ## Summary by CodeRabbit * **Documentation** * Updated contributor guidance to reference shared instructions in `AGENTS.md`. * Clarified that ongoing instruction updates should be maintained in `AGENTS.md`.  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-10-31 22:01:51 +00:00

bsakaguchi referenced this issue

2026-10-31 22:01:51 +00:00

[PR #154] [MERGED] fix(errors): surface a Router 422's detail[] on RouterError.errors from models.run #155

bsakaguchi closed this issue

2026-10-31 22:01:51 +00:00

bsakaguchi referenced this issue

2026-10-31 22:02:24 +00:00

[PR #218] [MERGED] docs(changelog): cut 0.5.0, and reconstruct the 0.4.0 section #218