review-compatibility

Reviews PRs for data-shape and interface compatibility hazards across deploy boundaries.

Updated May 19, 2026
One-click install
npx skills add https://github.com/kmosher/claude-plugins --skill review-compatibility-kmosher
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-compatibility
Source: https://github.com/kmosher/claude-plugins/tree/main/plugins/kmosher-review/skills/review-compatibility
Command: npx skills add https://github.com/kmosher/claude-plugins --skill review-compatibility-kmosher

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code changes that alter database schemas, message formats, or public interfaces can break callers, consumers, and old code that hasn't redeployed yet. This Skill catches those compatibility hazards before merge, when fixing them is cheap instead of during a production incident. ## Core Features & Use Cases - Data-Shape Review: Checks DDL migrations, protobuf/Avro schemas, stored state, and API payloads for forward/backward compatibility, lock hazards, and missing backfill plans. - Interface Compatibility Review: Flags breaking changes to exported function signatures, REST/gRPC endpoints, CLI flags, env vars, config keys, exit codes, and default-value flips. - Migration Pattern Guidance: Prescribes concrete multi-phase patterns (dual-write, NOT VALID/VALIDATE, CREATE INDEX CONCURRENTLY) with deploy ordering and rollback procedures for each P0/P1 finding. - Use Case: A PR adds a NOT NULL column to a 50M-row table and ships the reading code in the same commit. The Skill flags the table-lock risk and the reader/writer ordering hazard, then proposes splitting into three PRs with a nullable column, batched backfill, and a feature-flagged code deploy. ## Quick Start Ask the reviewer to check this PR for compatibility hazards across schema changes, API contracts, and callers that haven't redeployed yet.

Frequently Asked Questions about review-compatibility

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

FAQPage Schema
How do I review a database migration for production safety?▼

Check forward and backward compatibility in both directions, verify DDL is safe on populated tables (no NOT NULL without NOT VALID, use CREATE INDEX CONCURRENTLY), and confirm backfills are batched, idempotent, and resumable. Ship the migration separately from the code that depends on it.

What makes a schema change backward compatible?▼

A change is backward compatible when old code can still read new data and new code can read old data during the deploy window. Adding nullable columns, new tables, and optional protobuf fields are safe; renames, type changes, and NOT NULL additions require multi-phase dual-write patterns.

Does this review cover API and interface changes too?▼

Yes. It checks exported function signatures, REST/gRPC endpoint shapes, CLI flags, env vars, config keys, exit codes, and behavior semantics. Breaking changes like required-argument additions or silent default-value flips are flagged with deprecation-based alternatives.

When should I not use compatibility review?▼

Skip it for in-memory data structures that never cross deploy boundaries, single-binary atomic deploys with no external callers, test fixtures, and internal helpers with no outside consumers. If nothing depends on the prior shape, there is no compatibility event.

Why is adding a NOT NULL column dangerous on large tables?▼

On Postgres before version 11, ALTER TABLE ADD COLUMN NOT NULL DEFAULT rewrites the entire table under an exclusive lock. The safe pattern is adding the column nullable, backfilling in batches, then adding the constraint with NOT VALID followed by VALIDATE CONSTRAINT.