SuperAPI AI 工具集

diff-review-doc

测试与质量

查看项目

更新于 10-15 19:57

技能介绍

用途:从 git diff 生成完整的代码审查文档,供评审者直接阅读。

主要能力:解析 diff 识别变更文件与增删行;读取相关文件补充上下文;结合 references/patterns.md 识别反模式、安全漏洞与性能问题;按改动概览、业务流程分析、关键代码详解、风险评估四部分组织分析;依据 references/review-checklist.md 从代码质量、架构设计、功能验证、安全性、性能等维度给出 1-5 星评分、优点、问题与建议,并输出 Must Fix / Should Fix / Nice to Have 及合并结论;最终以 assets/review-template.md 为模板生成 Markdown 文件(如 REVIEW.md),含生成时间戳。

使用方式:用户可直接提供 diff;未提供时用脚本获取,如 ./scripts/get_diff.sh(默认未提交改动)、./scripts/get_diff.sh --staged、./scripts/get_diff.sh --branch main、./scripts/get_diff.sh --commit abc123。

适用场景:需要结构化评审意见的代码变更,尤其是后端文件、超过 200 行的大改动、架构与安全敏感代码。

限制:所有代码片段须取自真实 diff,不得使用占位示例;资料未说明支持的平台、收费方式与具体模型要求。