关于 review
review 是用于变更合入前检查当前分支与 main 差异的仓库 Skill。它按清单分关键和提示两轮审查,并报告所有发现。
主要功能
- 01比较分支与 main 的变更
- 02要求读取审查清单
- 03分两轮进行审查
- 04报告关键与提示类问题
适用场景
- 01合入前检查分支变更
- 02根据差异检查安全与结构问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ topshark-jim/ gstack --skill review安装后在 Claude Code 中输入/review确认已加载。
附带文件checklist.mdreferences/checklist.md
详细介绍
运行时注意事项
- 工作流要求暂停并等待输入时,直接询问用户。
- 将
AGENTS.md、TODO.md和TODOS.md视为仓库本地说明的可能来源。 - 保持工作流的意图不变,但将任何特定于环境的措辞替换为适用于当前工具集的表述。
合并前 PR 审查
你正在运行 review 工作流。针对 main 分支分析当前分支的差异,查找测试无法发现的结构性问题。
步骤 1:检查分支
- 运行
git branch --show-current获取当前分支。 - 如果当前分支是
main,输出:“无需审查 — 你当前位于 main 分支,或与 main 相比没有任何更改。” 然后停止。 - 运行
git fetch origin main --quiet && git diff origin/main --stat检查是否存在差异。如果没有差异,输出相同消息并停止。
步骤 2:阅读检查清单
阅读 references/checklist.md。
如果无法读取该文件,请停止并报告错误。 未阅读检查清单前,不得继续。
步骤 3:获取差异
获取最新的 main,避免因本地 main 过期而产生误报:
git fetch origin main --quiet
运行 git diff origin/main 获取完整差异。这包括相对于最新 main 的已提交和未提交更改。
步骤 4:分两轮审查
分两轮根据检查清单审查差异:
- 第 1 轮(严重): SQL 与数据安全、大模型输出信任边界
- 第 2 轮(提示性): 条件副作用、魔法数字与字符串耦合、死代码与一致性、大模型提示词问题、测试缺口、视图/前端
遵循检查清单中规定的输出格式。遵守抑制规则——不得报告“不要报告”部分列出的项目。
步骤 5:输出发现
始终输出所有发现——包括严重和提示性问题。用户必须看到每个问题。
- 如果发现严重问题:输出所有发现,然后针对每个严重问题,分别直接询问用户,说明问题、推荐的修复方案和选项(A:立即修复,B:确认知悉,C:误报——跳过)。 用户回答完所有严重问题后,输出用户对每个问题的选择摘要。如果用户对任何问题选择 A(修复),则应用推荐的修复方案。如果用户只选择了 B/C,则无需采取行动。
- 如果只发现非严重问题:输出发现。无需进一步操作。
- 如果未发现问题:输出
Pre-Landing Review: No issues found.
重要规则
- 发表评论前,阅读完整差异。 不要报告差异中已经解决的问题。
- 默认只读。 只有用户明确对严重问题选择“立即修复”时,才修改文件。绝不提交、推送或创建 PR。
- 简洁。 问题一行,修复方案一行。不写前言。
- 只报告实际问题。 没有问题的内容不要报告。
评论
支持 Markdown