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

New issue

Open

opened 2026-10-31 22:03:36 +00:00 by bsakaguchi · 1 comment

bsakaguchi commented

2026-10-31 22:03:36 +00:00

Owner

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

Originally assigned to: @christian-byrne on GitHub.

What — No AGENTS.md or CLAUDE.md.

Why it matters here — The codegen-from-spec workflow is the non-obvious thing about this repo — an agent that hand-edits a generated file will pass review and fail the codegen-drift job. That belongs in a file agents actually read.

Evidence

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

$ grep -n 'codegen' .github/workflows/ci.yml
(job: Check generated code is in sync with spec/openapi.yaml)

Fix

Document which files are generated, how to regenerate, and the internal-reference scanning rule the public-repo-hygiene job enforces.

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-typescript-sdk/issues/58 Originally assigned to: @christian-byrne on GitHub.  **What** — No `AGENTS.md` or `CLAUDE.md`. **Why it matters here** — The codegen-from-spec workflow is the non-obvious thing about this repo — an agent that hand-edits a generated file will pass review and fail the `codegen-drift` job. That belongs in a file agents actually read. **Evidence** ``` $ ls AGENTS.md CLAUDE.md 2>&1 | tail -1 ls: cannot access 'CLAUDE.md': No such file or directory $ grep -n 'codegen' .github/workflows/ci.yml (job: Check generated code is in sync with spec/openapi.yaml) ``` **Fix** Document which files are generated, how to regenerate, and the internal-reference scanning rule the `public-repo-hygiene` job enforces. --- Found by `repo-audit` during repo improvement sweep 2026-08-17. Parent: #53

bsakaguchi added the

priority:nice-to-have

audit:ai-readiness

effort:medium

labels

2026-10-31 22:03:36 +00:00

bsakaguchi commented

2026-10-31 22:03:36 +00:00

Author

Owner

@daichunghy commented on GitHub (Aug 23, 2026):

Current main now contains AGENTS.md in commit 41aeb5f from PR #60. It documents the codegen drift check, public-repository hygiene scan, and the exact pnpm verification commands. This issue looks resolved; leaving the note here so the open sweep does not count it as outstanding.

@daichunghy commented on GitHub (Aug 23, 2026): Current main now contains `AGENTS.md` in commit `41aeb5f` from PR #60. It documents the codegen drift check, public-repository hygiene scan, and the exact `pnpm` verification commands. This issue looks resolved; leaving the note here so the open sweep does not count it as outstanding.

bsakaguchi referenced this issue

2026-10-31 22:03:52 +00:00

[PR #6] [MERGED] chore: sync vendored Comfy API v2 spec (cloud@2d78853) #16