SuperAPI AI 工具集

super-good-pr

写作与研究

查看项目

更新于 10-15 22:15

技能介绍

用途:在编写或维护 PR 描述、回复评审意见时提供结构化写作指导,让评审者获得评估最终改动所需的上下文。核心是先用具体问题和最终行为开场,解释关键设计选择,并用真实证据支撑验证声明。

主要能力:确立事实来源,先读取 PR 标题、正文、基础分支、head commit 与仓库模板,并基于实际 diff 分析,不假设目标分支是 main;区分观察到的证据与预期行为,避免“安全”“完全覆盖”等过度声明。标题与开头需承载改动本身,保持触发、后果、新行为、机制原因的因果链完整。正文按需选用章节,如 What changes、How it works、Invariant、Rollout、Validation、Review focus、Follow-ups、Review delta,用散文解释、表格做对比。验证证据需记录命令或 CI 任务、结果及其证明范围,并说明局限。可用 Mermaid 图、截图或短片辅助说明请求流、时序、状态转换、模式关系或 UI 行为。

使用方式:更新前先读取实时 PR 正文,授权编辑时从捕获的实时正文出发,保留无关内容,重新获取后再写入,避免覆盖他人修改。推荐用文件方式提交正文:gh pr edit NUMBER --body-file /path/to/reviewed-pr-body.md。写入后回读保存内容并检查渲染。回复评审时对每条实质意见给出明确处置:已修复、不处理并说明原因、延后并给出后续项、或已过时并附证据。

适用场景:小型修复、迁移、堆叠 PR、回归修复、视觉行为变更等各类 PR 的说明与评审沟通。

限制:撰写草稿与发布是不同动作,只有用户授权相应外部操作时才可发布;人工撰写的正文、标题和草稿在获授权前保持只读;冻结状态持续有效。该技能不是固定十二段模板或变更日志生成器,不授予覆盖人工文字、发帖、合并或部署的权限,也不能替代实现评审或验证。资料未提供具体收费、平台支持范围等信息。