SuperAPI AI 工具集

checking-breaking-changes-in-php-framework

通用与其它

查看项目

更新于 10-16 08:02

技能介绍

用途:在对假定对外公开的 PHP 框架做代码评审时,判断改动是否属于破坏性变更,并确认破坏性变更是否被恰当处理。

主要能力:提供一套破坏性变更判定规则。对未标注 @internal 的类,除公开 API(public method)新增参数或设置默认值之外的修改都算破坏性变更;即使 API 本身不变、但因内部实现变化导致 API 响应结果变化,也算破坏性变更;若通过抽象化等方式扩大了类型范围,但仍能支持与既有相同的用例,则不按破坏性变更处理。对标注 @internal 的类,因其属于内部实现,所有公开 API 的变更都不算破坏性变更。

使用方式:作为代码评审清单使用,在评审中判断 Pull Request 是否包含破坏性变更;若包含,检查其内容是否已正确记录在 Pull Request 的 CHANGELOG.md 中。

适用场景:对外公开的 PHP 框架的代码评审。

限制:资料未提供该技能的具体安装命令、运行方式、支持的框架版本及其他平台信息。