skills.rest
thrillmade
thrillmadeOFFICIAL
Explore all skills by this author →
GitHub

api-contract-enforcement

Monitor pull requests for breaking changes to public API surfaces.

1|Updated May 15, 2026
Search Tags:#versioning#consistency#API#pull request#break change detection
One-click install
npx skills add https://github.com/thrillmade/agent-skills --skill api-contract-enforcement-thrillmade
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-enforcement
Source: https://github.com/thrillmade/agent-skills/tree/main/skills/api-contract-enforcement
Command: npx skills add https://github.com/thrillmade/agent-skills --skill api-contract-enforcement-thrillmade

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Prevents accidental breaking changes to public APIs by flagging potential issues during pull request reviews.

Core Features & Use Cases

  • Flagging Breaking Changes: Identifies and reports changes that could affect public API consumers.
  • API Change Analysis: Categorizes breaking changes into types such as removed fields, changed status codes, and reordered required fields.
  • Migration Path Guidance: Suggests migration paths and documentation changes for flagged issues.
  • Use Case: Integrates into the PR review process to ensure that any changes to the API are communicated and handled appropriately, maintaining backward compatibility with API consumers.

Quick Start

Run the skill on your PR and review any flagged changes in the pull request description.

Frequently Asked Questions about api-contract-enforcement

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

FAQPage Schema
How do I detect breaking API changes in a pull request?▼

To detect breaking API changes in a pull request, use a tool that monitors PRs and flags modifications to public API surfaces like removed fields or changed status codes. This requires integration with a PR review system to execute checks.

What counts as a breaking change in API versioning?▼

In API versioning, a breaking change includes removing fields, changing status codes, or reordering required fields. Identifying these patterns during PR reviews helps maintain backward compatibility with public API consumers.

How do I enforce API consistency during code reviews?▼

You can enforce API consistency by running an automated skill on your PRs that analyzes API change patterns and reports potential issues. It ensures changes are communicated and handled appropriately within the PR review process.

Do I need a PR review system integration to monitor public API surfaces?▼

Yes, you need a PR review system integration to monitor public API surfaces. The skill requires this environment to execute properly, scan changes, and flag potential breaking issues directly within the pull request workflow.

Can I get migration path guidance for flagged API breaking changes?▼

Yes, you can get migration path guidance for flagged API breaking changes. The API change analysis categorizes issues like removed fields and suggests appropriate migration paths along with necessary documentation updates.

What's the best way to prevent accidental breaking changes to public APIs?▼

The best way to prevent accidental breaking changes to public APIs is to flag potential issues during pull request reviews. This approach categorizes breaking changes and suggests migration paths before modifications are merged.

Related Skills

Explore More Software Engineering Skills→
riandeoliveirariandeoliveira

api-design

Guide extend-only evolution of public C# APIs to prevent breaking changes.

Community
Advanced
Razmik-KutinavaRazmik-Kutinava

API Changelog Generator

Generate structured API changelogs with semantic versioning and change classifications.

Community
Advanced
heaptracetechnologyheaptracetechnology
13

contract-test

Automate API contract testing with schema validation and OpenAPI checks.

Community
Advanced
Camilo8902Camilo8902

contract-testing-builder

Implement API contract testing with Pact and OpenAPI specifications.

Community
Advanced