eng-contract-codegen-coship

Featured

Contract co-ship for Compozy wire changes. Use when editing public DTOs, OpenAPI, JSON-RPC extension shapes, generated clients, or handler request/response semantics. Do not use for internal Go refactors or test-only changes that leave the wire contract unchanged.

AI & Automation 2,894 stars 189 forks Updated today MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Contract Codegen Co-Ship Ship changed wire contracts with their generated artifacts and affected consumers. Triggers include public DTOs under `internal/api/contract/` or `internal/api/spec/`, OpenAPI/generated clients, JSON-RPC extension shapes, and handler request/response/status/authentication/error semantics. 1. Identify the owning contract and compatibility regime. Preserve SD-013: public replacements auto-migrate losslessly where possible; otherwise retain the old shape for one release with warnings and a named removal release. Only documented experimental surfaces may skip that window. Internal consumers change together. 2. Use applicable sections of `references/coship-checklist.md` to trace consumers. Record impact once in the owning spec/task/PR using `docs/_memory/change-impact.md`; reuse existing decisions and group unaffected surfaces instead of producing a no-impact form per item. 3. Run root `make codegen` after changing the owning source. It also owns JSON-RPC Go-to-TypeScript generation. Inspect generated output and co-ship it with source; investigate unrelated drift or nondeterminism. 4. Update affected Web types, adapters, query keys/options, hooks, components, MSW fixtures, and stories. Import generated DTOs rather than maintaining copies. Read only the layers the changed shape reaches. 5. Update applicable site/protocol/config documentation and run `make cli-docs` for CLI changes. Document active migrations and deprecations; remove old public docs only...

Details

Author
compozy
Repository
compozy/compozy
Created
7 months ago
Last Updated
today
Language
Go
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category