SuperAPI AI 工具集

pr-description

编程与开发

查看项目

更新于 10-16 05:51

技能介绍

用途:为代码分支生成一份审查者能在一分钟内抓住重点的 Pull Request 描述。适用于要打开 PR、“写 PR 描述”或分支待审需要总结的场景。

主要能力与结构:先收集真实变更,禁止凭记忆编写,使用命令: git log main..HEAD --oneline git diff main...HEAD --stat 再按固定结构组织描述:What(一两句说明用户可见结果而非实现细节)、Why(解决的问题或工单,链接 issue)、How(仅写非显而易见的取舍与被否决方案,不做逐文件导览,diff 已体现)、Testing(实际运行的命令与结果,而非“应该能通过”)、Risk / rollback(可能破坏什么以及如何回滚)。还需标出审查者必须额外留意的内容,如迁移、认证变更、删除操作。

决策规则:diff 超过约 800 行时,开头给出“审查顺序”提示,指明先读哪些文件;纯依赖升级压缩为 What + 更新日志链接 + 测试证据;破坏性 API 变更在顶部放置 BREAKING 横幅并附迁移步骤。

完成标准:描述无需审查者打开 diff 即可回答 what/why/testing,且 Testing 中每项声明都对应实际执行过的命令。

限制:该技能的具体安装方式、运行环境、收费与平台支持等资料暂未提供。