SuperAPI AI 工具集

code-review-checklist

编程与开发

查看项目

更新于 10-16 01:18

技能介绍

用途:为特定 pull request 生成一份量身定制的代码审查清单,按语言、变更类型和风险等级调整深度,而不是套用通用模板。若需要亲自执行审查、运用高级判断而非只要清单,可改用 code-review-guide。

必要输入:语言与框架(如 TypeScript + React、Python + FastAPI、Go);变更类型(feature / bug fix / refactor / dependency upgrade / security patch / performance);风险等级(low / medium / high / critical);PR 描述(粘贴描述或链接);代码或 diff(可选,粘贴关键改动文件或 git diff,可显著提升清单针对性);作者背景(新人 / 资深 / 外部贡献者)。若缺少输入但仍需产出,用合理假设并标注“(assumed, confirm)”,最后列出假设;仅当核心主题本身缺失时才先提问。

输出结构:PR 概览(范围评估、建议审查深度、预估审查时间,约每 50 行 diff 用 5 分钟估算);正确性检查(按语言选择对应检查项,如 TypeScript/JavaScript 的类型定义、隐式 any、async/await、空值处理;Python 的类型注解、异常处理、资源关闭;Go 的错误处理、context 传播、goroutine 生命周期);变更类型专属检查(bug fix 是否有能捕获该缺陷的测试、是否治本;feature 的验收标准、边界情况、错误路径与可观测性;refactor 的行为不变、无范围蔓延、复杂度下降;依赖升级的破坏性变更、安全公告、许可证兼容);风险对应检查(low 到 critical 逐级增加回滚计划、监控、安全影响、数据迁移安全、功能开关、灰度发布、预发验证与上线后核查);测试充分性;审查决策框架(批准、要求修改、非阻断评论的具体条件);该变更类型的常见陷阱。

附带材料:references/review-depth-calibration.md 用于校准审查深度,templates/review-record.md 为用户自行填写文档提供模板。另含 0–40 分评分标准,32 分以上视为可交付,从语言针对性、风险深度校准、决策框架清晰度、陷阱具体性四个维度打分。

限制与反模式:不得生成忽略所述语言的通用清单;不得把“看起来没问题”当作有效审查结果;高风险与低风险审查深度必须区分;不应把每个风格偏好都当作阻断问题;不得跳过针对该语言与变更类型的常见陷阱部分。具体价格、平台与安装方式暂未提供。