[GH-ISSUE #58] Add AGENTS.md #5

New issue

Closed

opened 2026-10-26 22:40:25 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-26 22:40:25 +00:00

Owner

Originally created by @christian-byrne on GitHub (Aug 17, 2026).
Original GitHub issue: https://github.com/Comfy-Org/comfy-python-sdk/issues/58

Originally assigned to: @christian-byrne on GitHub.

What — No AGENTS.md or CLAUDE.md.

Why it matters here — Same trap as the TypeScript SDK: models are generated, and an agent that edits one by hand passes review and fails codegen-drift. Also worth recording that mypy is a required check, since the repo has no typecheck script name to discover it from.

Evidence

$ ls AGENTS.md CLAUDE.md 2>&1 | tail -1
ls: cannot access 'CLAUDE.md': No such file or directory

$ grep -n 'codegen\|mypy' .github/workflows/ci.yml
(jobs: Type check with mypy; Regenerate models and fail on drift)

Fix

Document which files are generated, how to regenerate, that mypy gates PRs, and the public-repo-hygiene internal-reference rule.

Found by repo-audit during repo improvement sweep 2026-08-17. Parent: #53

Originally created by @christian-byrne on GitHub (Aug 17, 2026). Original GitHub issue: https://github.com/Comfy-Org/comfy-python-sdk/issues/58 Originally assigned to: @christian-byrne on GitHub.  **What** — No `AGENTS.md` or `CLAUDE.md`. **Why it matters here** — Same trap as the TypeScript SDK: models are generated, and an agent that edits one by hand passes review and fails `codegen-drift`. Also worth recording that mypy is a required check, since the repo has no `typecheck` script name to discover it from. **Evidence** ``` $ ls AGENTS.md CLAUDE.md 2>&1 | tail -1 ls: cannot access 'CLAUDE.md': No such file or directory $ grep -n 'codegen\|mypy' .github/workflows/ci.yml (jobs: Type check with mypy; Regenerate models and fail on drift) ``` **Fix** Document which files are generated, how to regenerate, that mypy gates PRs, and the `public-repo-hygiene` internal-reference rule. --- Found by `repo-audit` during repo improvement sweep 2026-08-17. Parent: #53

bsakaguchi

2026-10-26 22:40:25 +00:00