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

New issue

Closed

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

bsakaguchi commented

2026-10-26 22:40:23 +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/54

Originally assigned to: @christian-byrne on GitHub.

What — No CONTRIBUTING.md.

Why it matters here — Public, published SDK with 7 contributors and 8 releases. Nothing documents that models are generated and checked by a codegen-drift CI job — an outside contributor will hand-edit a generated model and fail CI without knowing why.

Evidence

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

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

Fix

Document uv-based setup, the required checks (ruff lint + format, mypy, pytest, codegen-drift, build), and how to regenerate models.

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/54 Originally assigned to: @christian-byrne on GitHub.  **What** — No `CONTRIBUTING.md`. **Why it matters here** — Public, published SDK with 7 contributors and 8 releases. Nothing documents that models are generated and checked by a `codegen-drift` CI job — an outside contributor will hand-edit a generated model and fail CI without knowing why. **Evidence** ``` $ ls CONTRIBUTING.md ls: cannot access 'CONTRIBUTING.md': No such file or directory $ gh api repos/Comfy-Org/comfy-python-sdk -q .visibility public ``` **Fix** Document uv-based setup, the required checks (ruff lint + format, mypy, pytest, codegen-drift, build), and how to regenerate models. --- Found by `repo-audit` during repo improvement sweep 2026-08-17. Parent: #53

bsakaguchi

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