velcrafting

compatibility-check

Validate API compatibility across versions or consumers.

velcrafting 1 Updated 7mo ago
GitHub

Install

npx skillscat add velcrafting/codex-skills/compatibility-check

Install via the SkillsCat registry.

About this skill

We need to produce a 2-3 sentence plain-text summary, objective, factual, no marketing, no superlatives, no calls to action. Must be at most 60 words. No bullet points, no headings, no markdown. Just plain text. We need to explain what the skill does, what problem it solves, when to use it. From description: Validate API compatibility across versions or consumers. It determines if API change is backward-compatible, conditionally compatible, breaking. Inputs: old contract, new contract, known consumers. Outputs: compatibility assessment, list of breaking changes, recommendation.

SKILL.md

Skill: api/compatibility-check

Purpose

Determine whether an API change is:

  • backward-compatible
  • conditionally compatible
  • breaking

And make that status explicit before shipping.


Inputs

  • Old contract
  • New contract
  • Known consumers (if available)

Outputs

  • Compatibility assessment:
    • compatible / breaking / unsafe
  • Explicit list of breaking changes (if any)
  • Recommendation:
    • proceed
    • version
    • block

Non-goals

  • Modifying contracts
  • Updating clients
  • Implementing migrations

Workflow

  1. Compare old vs new contract shapes.
  2. Identify removed or behaviorally changed fields.
  3. Assess consumer impact.
  4. Emit a clear compatibility verdict.

Checks

  • All removals and type changes enumerated
  • Verdict is explicit and justified

Failure modes

  • Missing baseline contract → block and request one.
  • Ambiguous change → recommend meta/spec-sculptor.

Telemetry

Log:

  • skill: api/compatibility-check
  • verdict
  • affected_consumers
  • outcome