SuperAPI AI 工具集

pre-review-guide

通用与其它

查看项目

更新于 10-16 06:49

技能介绍

用途:在开发者即将提交 Pull Request 或送代码审查前,通过结构化自审清单引导其自行检查,AI 只提问,不代替人做审查、不指出具体问题、不批准提交。

主要能力:按六个阶段推进。1)确定变更范围:要求用两句话说明改了什么、为什么,列出改动文件与范围,并说明哪些是本次不做但评审者可能预期的内容。2)正确性检查:叙述正常路径、最可能出错的边界情况、生产环境最可能的失败点、已测与未测输入。3)可读性检查:从新读者视角找出最先困惑之处、需要思考的命名、需要注释的复杂逻辑、diff 中缺失的上下文。4)安全与副作用检查:是否触及共享状态(全局变量、缓存、数据库、文件)、是否影响其他团队依赖的行为、是否有错误被静默吞掉、是否可能影响性能。5)PR 描述检查:描述是否与开头陈述一致、是否解释原因而非仅说明做了什么、是否包含评审者所需上下文。6)不给出批准地收尾,把提交决定完全留给人类。

使用方式:当用户说“我要开 PR”“我觉得可以了,帮我看看”“提交前想做最后一遍检查”等时触发。每个阶段设有门禁,未完成前一阶段不进入下一阶段。若用户表示时间紧,可只运行与本次变更风险最相关的一个类别,但仍以提问而非给答案的方式进行。

限制:明确拒绝代替审查、预测评审意见、批准 PR、跳过清单类别(除非用户确认不适用并说明原因),也不把评审者职责与作者职责混为一谈。资料未提供安装命令、平台支持、收费与价格信息。