[GH-ISSUE #54] Add CONTRIBUTING.md #3

New issue

Closed

opened 2026-10-31 22:03:35 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:03:35 +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/54

Originally assigned to: @christian-byrne on GitHub.

What — No CONTRIBUTING.md.

Why it matters here — This is a public, published SDK with 7 contributors and 8 releases. An outside contributor has no documented path: nothing states that codegen must stay in sync with spec/openapi.yaml, which is a required CI job they will trip over on their first PR.

Evidence

$ ls CONTRIBUTING.md
ls: cannot access 'CONTRIBUTING.md': No such file or directory

$ gh api repos/Comfy-Org/comfy-typescript-sdk -q .visibility
public

Fix

Document local setup (pnpm), the required checks (oxlint, oxfmt, typecheck, codegen-drift, tests, build), and how to regenerate from spec/openapi.yaml.

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/54 Originally assigned to: @christian-byrne on GitHub.  **What** — No `CONTRIBUTING.md`. **Why it matters here** — This is a public, published SDK with 7 contributors and 8 releases. An outside contributor has no documented path: nothing states that codegen must stay in sync with `spec/openapi.yaml`, which is a required CI job they will trip over on their first PR. **Evidence** ``` $ ls CONTRIBUTING.md ls: cannot access 'CONTRIBUTING.md': No such file or directory $ gh api repos/Comfy-Org/comfy-typescript-sdk -q .visibility public ``` **Fix** Document local setup (pnpm), the required checks (oxlint, oxfmt, typecheck, codegen-drift, tests, build), and how to regenerate from `spec/openapi.yaml`. --- Found by `repo-audit` during repo improvement sweep 2026-08-17. Parent: #53

bsakaguchi

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