skills.rest
Notysoty
NotysotyCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

Breaking Change Detector

Identify breaking changes between two codebase or API versions.

9|1|Updated Mar 15, 2026
Search Tags:#versioning#api#migration#diff#breaking-changes#contract
One-click install
npx skills add https://github.com/Notysoty/openagentskills --skill breaking-change-detector-notysoty
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Breaking Change Detector
Source: https://github.com/Notysoty/openagentskills/tree/main/skills/breaking-change-detector
Command: npx skills add https://github.com/Notysoty/openagentskills --skill breaking-change-detector-notysoty

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Compares two versions of a codebase, API, or interface and identifies all breaking changes with actionable migration hints to help teams preserve compatibility.

Core Features & Use Cases

  • Classifies differences by public contract impact (exports, endpoints, schemas) and assigns a severity level.
  • Produces concrete migration hints for each breaking change to guide client updates.
  • Works across libraries, APIs, and interfaces to catch contract drift before releases.
  • Ideal for use before publishing new package versions, deploying API changes, or during code reviews.

Quick Start

Copy this file to your project root and provide the old and new versions to generate a migration-ready breaking-change report.

Frequently Asked Questions about Breaking Change Detector

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check for breaking API changes between two versions of a codebase?▼

To check for breaking API changes, compare the old and new versions to enumerate differences by public contract, classify severity levels, and yield migration hints for each breaking change identified.

What is a breaking change detector and when do I need it for versioning?▼

A breaking change detector identifies compatibility issues in public contracts before releases. You need it for library releases, REST API changes, or interface schema migrations to ensure compatibility and prevent contract drift.

How do I generate migration hints for REST API changes during a release?▼

Generate migration hints by comparing old and new API versions to classify contract differences by severity. This yields concrete migration hints guiding client updates for each breaking change detected.

Can I use this to catch contract drift in interface schema migrations?▼

Yes, you can catch contract drift in interface schema migrations by enumerating differences in public contracts. The detector classifies these changes by severity and provides migration hints to ensure compatibility.

What is the best way to compare two versions of a library to preserve compatibility?▼

The best way to preserve compatibility is comparing two library versions by public contract impact, classifying differences by severity, and reviewing the generated migration hints before publishing new package versions.

Related Skills

Explore More Software Engineering Skills→
erraggyerraggy
5

diff-specs

Diff two OpenAPI specifications to identify breaking changes and migration steps.

Community
Intermediate
machenjiemachenjie
4

sdk-library-contract-design

Design SDK and library contracts to minimize breaking upgrades across semver.

Community
Advanced
nanorepublicananorepublica
61

Global Tech Stack

Validate code against centralized global tech stack standards.

Community
Basic
yuhle-qugyuhle-qug

rest-api-expert

Design REST APIs with HTTP semantics and OpenAPI documentation.

Community
Intermediate