eng-contract-codegen-coship
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.
- License 许可
- MIT
- 所属仓库
- compozy/compozy
- 最近更新
- 2026-11-14
- Stars
- ★ 2.9k
- Forks
- 187
01 前言 Front Matter
- name
- eng-contract-codegen-coship
- trigger
- implicit
- description
- 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.
02 资源文件 1
- 参考文档references/coship-checklist.md2.5 KB
03 SKILL.md 正文
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.
- 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.
- Use applicable sections of
references/coship-checklist.mdto trace consumers. Record impact once in the owning spec/task/PR usingdocs/_memory/change-impact.md; reuse existing decisions and group unaffected surfaces instead of producing a no-impact form per item. - Run root
make codegenafter 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. - 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.
- Update applicable site/protocol/config documentation and run
make cli-docsfor CLI changes. Document active migrations and deprecations; remove old public docs only when the corresponding surface is eligible for removal under SD-013. - Verify no generator drift with
make codegen-checkand use the affected root Turbo lint/typecheck/test/build lanes for Web/site changes. Repository-wide gates run only in CI, per rootCLAUDE.md.
Complete when source, generated output, affected consumers, fixtures, docs, and required delivery evidence agree. A local task does not acquire a PR-publication requirement merely by loading this skill.
If a consumer typecheck fails, diagnose the actual mismatch; it does not automatically prove a mirrored DTO. For runner-only failures, inspect the failing CI lane and reproduce the relevant environment rather than assuming every failure is Linux race parity.
04 同仓库更多 Skills
security-review
Security code review for vulnerabilities. Use when asked to "security review", "find vulnerabilities", "check for security issues", "audit security", "OWASP review", or review code for injection, XSS, authentication, authorization, cryptography issues. Provides systematic review with confidence-based reporting.
lesson-learned
Extract evidence-backed engineering lessons from recent changes or incidents. Use for requested reflection, lesson updates, or retiring an obsolete workflow rule.
compozy
Operate CompozyOS. Use when working with CompozyOS sessions, agents, native tools, skills, tasks, Loops, Goals, Terminal, desktops and windows, automation, extensions, or configuration. Don't use for unrelated projects.
remotion-upgrade
Upgrade Remotion, and related packages
remotion-studio
Preview a Remotion video
remotion-saas
Build an app with Remotion