checking-breaking-changes-in-php-framework

外部公開を想定したphpフレームワークのコードレビューをする際に、破壊的変更(breaking change)の有無を確認し、破壊的変更がある場合は適切に処理されているかをチェックするスキルです。

⭐0stars🔀0forks📁View on GitHub🕐Updated Dec 18, 2025

When & Why to Use This Skill

This Claude skill specializes in auditing PHP framework code for breaking changes during the code review process. It intelligently distinguishes between public APIs and internal implementations (marked with @internal tags) to identify backward-incompatible modifications. By automating the detection of signature changes, response alterations, and documentation gaps in CHANGELOG.md, it helps maintainers ensure framework stability and clear communication with downstream developers.

Use Cases

  • Automated Pull Request Auditing: Automatically scan incoming PRs in PHP framework repositories to flag any breaking changes in public methods before they are merged.
  • Semantic Versioning Enforcement: Identify critical API changes that necessitate a major version bump, ensuring the project adheres to SemVer principles.
  • Documentation Compliance: Verify that every identified breaking change is accurately recorded in the CHANGELOG.md to maintain transparency for the developer community.
  • Internal Refactoring Validation: Allow developers to refactor classes marked with @internal without triggering false positive breaking change alerts, streamlining internal code improvements.
name"checking-breaking-changes-in-php-framework"
description"外部公開を想定したphpフレームワークのコードレビューをする際に、破壊的変更(breaking change)の有無を確認し、破壊的変更がある場合は適切に処理されているかをチェックするスキルです。"

Rules for Breaking Changes in PHP Framework

以下のルールに従って、コードレビュー時に変更が「破壊的変更」か否かを決定する。

@internal tagがついていないクラス

  • 公開API(public method)の引数追加やデフォルト値を設定する以外の変更
  • APIが変わらない場合もAPI内部実装の変更によりAPIのレスポンスが変化する場合
  • 抽象化等により型範囲が広がるが既存と同様のユースケースが可能な場合は破壊的変更扱いしない

@internal tagがついているクラス

  • 内部用の実装のため全ての公開APIの変更を破壊的変更扱いしない

Code Review Checklist

  • Pull Request が破壊的変更を含むかどうかをレビューに含めます
  • 破壊的変更が行われている場合はその内容が Pull Request の CHANGELOG.md に適切に記載されていることを確認します