schema-compatibility-review

Name: schema-compatibility-review
Availability: InStock
Author: gautam-achieveai

Analyze code changes for schema and contract compatibility issues.

2|Updated Apr 12, 2026

Search Tags:#code review #database migration #json #protobuf #schema compatibility

Ready to run

npx skills add https://github.com/gautam-achieveai/ClaudePlugins --skill schema-compatibility-review

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: schema-compatibility-review
Source: https://github.com/gautam-achieveai/ClaudePlugins/tree/main/code-reviewer/skills/schema-compatibility-review
Command: npx skills add https://github.com/gautam-achieveai/ClaudePlugins --skill schema-compatibility-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill identifies and mitigates schema and wire-contract compatibility issues, ensuring changes do not cause silent data loss or functional breakages.

Core Features & Use Cases

Compatibility Checks: Detects issues like removed fields, added required fields, changed field types, and enum value changes.
Change Pattern Analysis: Analyzes nine specific change patterns and their impact on backward compatibility, forward compatibility, rollout sequencing, public surfaces, and serializer/deserializer symmetry.
Technical References: Provides detailed guidance on handling specific schema technologies like protobuf, JSON DTOs, Orleans, and database migrations.

Quick Start

Use the schema-compatibility-review skill to review the proposed changes in the PR and flag any compatibility issues.

Frequently Asked Questions about schema-compatibility-review

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

FAQPage Schema

How do I check protobuf schema compatibility before deploying changes?▼

To check protobuf schema compatibility, analyze code changes for removed fields, added required fields, changed field types, and enum value changes that break wire contracts. This review identifies backward and forward compatibility issues across serializers and deserializers prior to deployment.

What is schema compatibility and when do I need to review it?▼

Schema compatibility review is the process of analyzing data persistence and service interoperability impacts during schema changes. You need it when modifying protobuf, JSON DTOs, Orleans grains, or database migrations to prevent silent data loss and functional breakages.

How do I review database migrations for backward compatibility in a pull request?▼

Review database migrations by analyzing change patterns for rollout sequencing and public surface impacts. This detects schema incompatibilities like removed fields or type changes that break deserializer symmetry, ensuring data persistence is maintained during deployment.

Can I detect JSON DTO contract breaking changes automatically?▼

Yes, you can detect JSON DTO contract breaking changes by analyzing nine specific change patterns. This analysis flags added required fields, removed fields, and changed types that impact forward and backward compatibility, preventing functional breakages.

What are the limitations of automated schema compatibility checks?▼

Automated schema compatibility checks require knowledge of schema evolution rules specific to protobuf, JSON, Orleans, and database migrations. Limitations include the inability to detect business logic failures and reliance on accurate serializer and deserializer symmetry analysis across public surfaces.