compatibility-check

Name: compatibility-check
Availability: InStock
Author: velcrafting

_placeholder_

1|Updated Jan 13, 2026

Search Tags:#versioning #api #compatibility #governance #assessment #breaking-changes #contracts

Ready to run

npx skills add https://github.com/velcrafting/codex-skills --skill compatibility-check

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: compatibility-check
Source: https://github.com/velcrafting/codex-skills/tree/main/skills/api/compatibility-check
Command: npx skills add https://github.com/velcrafting/codex-skills --skill compatibility-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Validate and categorize API compatibility between versions or consumers, enabling early decisions before shipping.

Core Features & Use Cases

Backward compatibility assessment across contract changes
Explicit verdicts (compatible, breaking, unsafe) with a list of breaking changes
Actionable recommendations on release strategy and versioning

Quick Start

Compare the old and new contract definitions to generate a compatibility verdict and identify breaking changes.

Frequently Asked Questions about compatibility-check

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

FAQPage Schema

How do I check API compatibility between two contract versions?▼

To verify API compatibility, compare old and new contract definitions to generate a verdict. This assessment identifies whether changes are compatible, breaking, or unsafe before shipping public API updates.

What is a breaking change in API versioning?▼

A breaking change in API versioning is a contract modification that disrupts known consumers, libraries, or integrations. Compatibility assessment explicitly enumerates these breaking changes to prevent unintended disruptions.

When do I need to assess backward compatibility for my API?▼

You need to assess backward compatibility when shipping changes to public APIs. This assessment evaluates the impact on known consumers, libraries, and integrations to determine if the update is safe.

Can I get actionable recommendations on release strategy after an API compatibility check?▼

Yes, an API compatibility check provides actionable recommendations on release strategy and versioning. These guidelines are generated alongside the compatibility verdict to help you safely ship contract changes.

Does this compatibility assessment work for internal libraries or only public APIs?▼

This compatibility assessment is applied when shipping changes to public APIs and assessing impact on known consumers, libraries, or integrations. It evaluates contract changes to determine if updates are compatible, breaking, or unsafe.