Comfy-Org / Comfy-Org/comfy-typescript-sdk

Add AGENTS.md

Open
#58 1 comment 0 reactions 1 assignee Claimed by @christian-byrne View on GitHub
audit:ai-readiness effort:medium priority:nice-to-have
Dominant language
TypeScript
Stars
8
Forks
3
Avg merge
3d 14h
Merged PRs (30d)
47

Description

**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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.