SuperAPI AI 工具集

056-design-avoid-breaking-changes

编程与开发

查看项目

更新于 10-15 22:39

技能介绍

用途:在实施或发布推广前,审查仓库计划变更的破坏性变更与兼容性风险。这是一个交互式 SKILL,强调基于证据、只读、聚焦兼容性风险,除非用户明确要求实施。

主要能力:覆盖命令契约兼容性(名称、输入、归属智能体、输出、防护措施、安装器注册、命令清单);技能路由兼容性(标识符、元数据、描述、触发器、引用、生成的本地输出、验收覆盖);生成产物归属(XML/源文件与 .agents/skills、public skills/、.cursor/commands、.cursor/rules、docs/);源与生成器契约(XML、XInclude、XSLT、Maven 模块、schema 预期、模块校验);README、本地化 README、变更日志、迁移与弃用指引;外部与运行时契约(API、schema、数据格式、配置键、持久化、CLI 行为、CI 预期);结构化兼容性报告,含按严重程度排序的发现与验证指引。

使用方式:先阅读 references/056-design-avoid-breaking-changes.md,再识别待审查源产物、其权威性以及请求是只读审查还是已批准实施;清点兼容性表面;将每项发现分类为 BREAKING、POTENTIALLY BREAKING、NON-BREAKING 或 UNKNOWN,并注明受影响用户、产物、契约与验证证据;对确认或潜在风险建议弃用、兼容窗口、迁移说明、发布说明更新、生成器检查、聚焦测试或负责人决策;最后输出简洁兼容性报告,含已审查来源、按表面的风险摘要、按严重程度排序的发现、建议验证,以及未发现风险时的明确无风险声明。

适用场景:审查本规范中的破坏性变更、检查兼容性风险、避免 OpenSpec 变更中的破坏性变更、发布前审查迁移影响、评估命令与技能兼容性、发现生成产物兼容性风险、审查 API/schema/配置或数据契约变更。

限制:必须保持基于证据、只读且限定于兼容性风险;必须区分已确认破坏性变更、潜在风险、非破坏性变更与需维护者决策的未知项;必须尊重仓库源归属,编辑 XML 与源文档,通过文档化工作流重新生成产物,避免直接编辑生成产物,除非仓库明确拥有该文件;审查期间不得修改计划、规范、源文件、生成产物或问题描述,除非用户明确要求实施。详细指引、示例与约束见 references/056-design-avoid-breaking-changes.md。