SuperAPI AI 工具集

pr-hygiene

编程与开发

查看项目

更新于 10-16 02:37

技能介绍

PR Hygiene 的用途是把当前工作整理成一个人工可一次审阅完的 PR。开 PR 前的检查包括:分支只含一个逻辑改动(或清晰标注的分层提交);没有遗留的 console.log、debugger、TODO: temp、自己添加的注释代码块;没有无关的纯格式改动;密钥、.env 和本地专用文件未被暂存;diff 与声明的目标一致,没有“额外好心”的改动。

描述模板采用固定结构:Summary(1–3 条要点,说明做了什么和为何做)、Test plan、Notes(风险、后续事项、UI 截图)。提交/PR 标题要求使用祈使句且具体,例如 fix checkout: reject expired discount codes,避免 update stuff、fix、WIP、address comments 等。

面向审阅者的同理心部分要求主动指出:看起来吓人但属机械性改动的文件(重命名、生成文件)、对调用方或 API 消费者改变的行为、以及自己不确定的地方。反模式包括:除非必要,绝不在一个 PR 中混入重构加功能加依赖升级;不在未警告时强推共享分支;不带计划地以“tests TBD”开 PR;不把破坏性变更埋在描述中间。若被要求开 PR,流程为:先用自己的话总结 diff,再用模板起草标题和正文,最后用一小节列出残余风险。该资料未提供安装命令、代码示例、平台支持范围或收费信息,这些暂未提供。