Api contract compatibility review
Skill motao123/dev-workflow-kit/api-contract-compatibility-review
21 markdown-first software delivery workflow skills for Claude Code, Codex, and compatible agents. Standalone skill kit covering planning, debugging, CI, review, security, rollout, performance, data quality, and post-incident workflows.
npx -y skills add motao123/dev-workflow-kit --skill api-contract-compatibility-reviewAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Use when an API, schema, payload, event, or contract change must be checked for backward compatibility, client impact, versioning risk, and migration safety.
The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
1.9 KB, as published. Nobody here has run it
API Contract Compatibility Review
Use this skill when the main risk is breaking consumers through interface changes.
Trigger Conditions
Use this skill when:
- request or response shapes are changing
- schema, event, or payload contracts may break old clients or downstream services
- the user asks whether a change is backward compatible
- versioning, migration, or deprecation strategy needs review
- integration risk matters more than internal implementation details
Do not use this skill for generic refactor planning or dependency/license review.
Workflow
- Identify the contract under change.
- Compare current and proposed behavior or shapes.
- Check backward and forward compatibility risks.
- Identify affected consumers, migration needs, and deprecation concerns.
- Recommend versioning or rollout safeguards.
- Suggest verification and communication steps.
Output
For non-trivial work, provide:
- contract surface reviewed
- compatibility risks
- likely breaking changes
- migration or versioning guidance
- verification focus
- recommended next action
Coordination
After contract review:
- use
change-impact-analysisif the consumer surface is still unclear - use
release-rollout-strategywhen compatibility risk changes rollout shape - use
docs-writerwhen migration guidance or deprecation notes should be published
Invocation Examples
- "Use api-contract-compatibility-review to check whether this endpoint change breaks old clients."
- "Use api-contract-compatibility-review on this event schema update before release."
- "Use api-contract-compatibility-review and tell me whether we need versioning or migration guidance."