SuperAPI AI 工具集

make-pr-easy-to-review

通用与其它

查看项目

更新于 10-15 23:28

技能介绍

用途:让审阅者快速理解 PR 的意图、重要文件与风险,默认目标是在不改变代码行为的前提下提升可审阅性。

主要能力:从用户提供的 URL 或当前分支定位目标 PR;检查提交、diff 大小、变更路径、生成文件与 PR 描述;识别可审阅性问题,如提交噪音、描述过时、无关改动、机械性改动与逻辑改动混杂、缺少测试或入口不清。

使用方式:先提出计划,再重写历史或强制推送;应用安全改进后验证目录或 diff 仍与预期代码一致。仅当用户要求或同意计划时才重写历史,重写前可运行 gh pr view <PR> --json title,headRefName,baseRefName,state,commits、git fetch origin <headRefName> <baseRefName>、ORIGINAL_TREE=$(git rev-parse origin/<headRefName>^{tree})。提交分组通常按依赖顺序:schema/存储或生成的 API 定义、核心逻辑、接线与集成、UI 或界面行为、测试。重写后验证内容一致性:echo "Original tree: $ORIGINAL_TREE"、echo "Current tree: $(git rev-parse HEAD^{tree})"、git diff origin/<headRefName> --stat。若目录意外变化,不要推送。

审阅指引:当不应改动代码行为时,优先改进 PR 描述与审阅说明:添加与实际 diff 相符的 TL;DR;区分核心文件与生成或机械性文件;标注有风险的行为变更、迁移顺序、发布计划和测试覆盖;在有助于说明意图时链接 issue、仪表盘或设计文档。

限制与护栏:不得把有意义的行为变更藏在“清理”中;除非用户明确要求,不要绕过 hooks;若 PR 过大以致注释无法使其可审阅,建议拆分,而不是在问题外围打磨。