用途:在创建 Pull Request、撰写 PR 描述或准备代码评审时使用,目标是让评审者理解改了什么、为什么改、如何测试以及出问题如何回滚。它把 PR 描述定位为决策文档,而非变更日志。
主要能力:提供固定模板,包含 Summary(1-3 条高层摘要并关联 Jira/GitHub issue)、Background(上下文、问题、修复思路、顺带修复)、Test plan(自动化测试与手动验证清单)、Rollback plan(回滚方案)。附带回滚复杂度指南,按变更类型区分处理方式:纯代码改动直接 revert;新增式数据库迁移需 revert 并回滚迁移;破坏性迁移不能简单 revert,需写正向迁移恢复;数据回填需 undo 脚本;外部 webhook 需在外部服务禁用;功能开关需先关开关再 revert;缓存结构变更需清理相关键;队列/任务格式变更需先排空队列。
使用方式:按模板填写各段落。摘要写意图而非文件清单;背景需定义术语、解释系统现状与数据模型关系;说明选择该方案的原因及被否决的替代方案;用 Refs JIRA-KEY 关联相关工作,Closes/Fixes JIRA-KEY 表示直接修复;测试计划用 - [ ] 复选框,区分自动化与手动,并给出新增/修改用例数量;回滚方案必填,默认“Revert this PR”,涉及迁移、回填、外部服务、开关、缓存或队列时写明完整步骤。
适用场景:团队代码评审流程、需要评审者快速掌握上下文的改动、含数据库或外部依赖等高风险变更。
限制:资料未提供该技能的安装命令、运行环境、平台支持或收费信息;模板中的 Jira 链接与键名需替换为实际项目地址。