version-compatibility

Community

Safely ship contract changes across versions

Authormachenjie
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Prevents breaking behavior when APIs, schemas, events, configuration, and observable behavior evolve while old and new producers/consumers coexist during rollout and rollback scenarios.

Core Features & Use Cases

  • End-to-end compatibility evaluation: Assesses compatibility across contract surfaces including structure, meaning, validation, defaults, and behavior.
  • Bidirectional safety checks: Verifies both “old producer → new consumer” and “new producer → old consumer,” including rollback after mixed deployments.
  • Breaking-change governance: Requires explicit mitigations for breaking changes via versioning, backward-compatible bridge, or expand-contract migration path with rollback safety.
  • Rollout and deprecation discipline: Defines mixed-version behavior, rollout sequencing (expand before contract), and telemetry-gated deprecation/removal criteria.

Use case example: When adding a new request field or changing enum/validation rules for a public endpoint or event, use this capability to determine whether the change is safe, what mitigation is required, and how to sequence deployment to avoid data corruption and consumer failures.

Quick Start

Ask for a compatibility assessment by describing the proposed change, the affected contract surfaces, and the current and target versions, then request a rollout and rollback-safe migration plan.

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: version-compatibility
Download link: https://github.com/machenjie/rd-skills/archive/main.zip#version-compatibility

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 471,000+ vetted skills library on demand.