contract-consistency-validation

Community

Ensure API changes are safe and compatible.

Authormcj-coder
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill prevents accidental breaking changes in APIs and contracts, ensuring backward compatibility and minimizing disruption for consumers.

Core Features & Use Cases

  • Breaking Change Detection: Automatically identifies modifications that could break existing integrations.
  • SemVer Enforcement: Guides version bumping according to Semantic Versioning rules.
  • User Confirmation: Requires explicit approval for breaking changes.
  • ADR Mandate: Enforces documentation for pre-1.0 relaxations or v1+ exceptions.
  • Use Case: When a developer proposes removing a field from an API response, this Skill will flag it as a breaking change, explain the impact on consumers, and require confirmation before proceeding.

Quick Start

Use the contract-consistency-validation skill to check if changing the user API response by adding an optional 'phone' field is a breaking change.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: contract-consistency-validation
Download link: https://github.com/mcj-coder/development-skills/archive/main.zip#contract-consistency-validation

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.