关于 code-review-md
这是 `code-review` 技能的变体,将审查结果保存为 Markdown 报告,不生成 HTML 或打开浏览器。它依赖主技能中的审查规则,适用于提交前需要留存审查记录的工作流。
主要功能
- 01将 Markdown 报告保存到 `.reviews/`
- 02遵循主技能的审查流程
- 03跳过 HTML 生成
- 04交接时提供分级问题统计
适用场景
- 01提交前审查代码差异
- 02将审查发现保存为仓库文件
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ chann/ skills --skill code-review-md安装后在 Claude Code 中输入/code-review-md确认已加载。
附带文件agents/openai.yamlevals/evals.json
详细介绍
代码审查(Markdown 报告)
概述
code-review 技能的变体,仅将审查发现保存到 .reviews/<YYYY-MM-DD>_<short-sha>.md,不生成 HTML 报告,也不打开浏览器。
工作流
开始前,请阅读主 code-review 的 SKILL.md,路径为 <plugin-root>/skills/code-review/SKILL.md — 审查流程步骤、严重性表、语言参考映射和报告 Markdown 模板都在其中。此变体依赖这些内容。
主技能的证据优先写作约定和条件章节规则具有权威性。不要在此重述或弱化这些规则。
然后严格遵循主 SKILL.md 中的审查流程 — 步骤 1–4(收集上下文、加载参考资料、分析、撰写报告)以及步骤 6(交接)。跳过步骤 5(HTML)。
简而言之:
- 确定审查范围并运行相应的
git diff(参见主 SKILL.md 中的“确定审查范围”)。 - 运行
diff_stats.py,加载相关语言的参考资料;如果涉及安全,则加载common-vulnerabilities.md。 - 根据五个维度分析差异并评定严重性。
- 在此持久化 Markdown 模式下,如果
.reviews/不存在则创建它,并使用主 SKILL.md 中的 Markdown 模板撰写报告(“撰写 Markdown 报告”)。 - 交接内容仅包含事实:各严重级别的发现数量、总体风险、Markdown 文件路径以及最新验证结果。不要重复报告正文,也不要承诺固定的发现数量。
仅当已生成文件且 .reviews/ 未被忽略时,才在交接中建议将 .reviews/ 加入忽略列表。绝不要自动修改 .gitignore。
文件名
.reviews/<YYYY-MM-DD>_<short-sha>.md — 参见主 SKILL.md 中的“快速参考 / 文件名约定”。
语言
与用户提示所用语言一致;参见主 SKILL.md 中的“报告语言”。保留对解析器有意义的英文元数据键,并在元数据标题中添加 **Language:** <bcp47>。
警示事项
与主 <plugin-root>/skills/code-review/SKILL.md> 中相同的 Never/Always 列表。特别注意:绝不要自动修改 .gitignore(仅提出建议),绝不要评论差异之外的代码,也绝不要将 INFO 用于表达不确定性或赞扬。
集成
搭配使用: git-commit — 提交前进行审查,作为最终质量检查。