关于 comprehensive-review-pr-enhance
将 Git diff 整理为面向审阅者的结构化 Pull Request 描述。它归类变更、风险和测试说明,并按文件类别生成检查清单,同时强调启发式分析不等于已验证结果。
主要功能
- 01检查 diff 范围
- 02变更分类
- 03结构化 PR 描述
- 04按需生成审阅清单
- 05建议拆分大型变更
适用场景
- 01编写详细的 PR 描述
- 02标记安全敏感变更
- 03根据变更文件生成审阅清单
- 04评估是否拆分大型 PR
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ sickn33/ agentic-awesome-skills --skill comprehensive-review-pr-enhance安装后在 Claude Code 中输入/comprehensive-review-pr-enhance确认已加载。
附带文件resources/implementation-playbook.md
详细介绍
拉取请求增强
适用场景
- 你需要将 git diff 转换为便于审阅的拉取请求描述。
- 你希望 PR 摘要包含变更类别、风险、测试说明和检查清单。
- diff 足够大,审阅者需要明确的结构,而不是简短的临时摘要。
工作流
- 运行
git diff <base>...HEAD --stat,识别变更文件和范围 - 对变更分类:源代码、测试、配置、文档、构建、样式
- 使用下方模板生成 PR 描述
- 根据发生变更的文件类别添加审阅检查清单
- 标记破坏性变更、安全敏感文件或大型 diff(>500 行)
PR 描述模板
## Summary
## Changes
| Category | Files | Key change |
|----------|-------|------------|
| source | `src/auth.ts` | added OAuth2 PKCE flow |
| test | `tests/auth.test.ts` | covers token refresh edge case |
| config | `.env.example` | new `OAUTH_CLIENT_ID` var |
## Why
## Testing
- [ ] unit tests pass (`npm test`)
- [ ] manual smoke test on staging
- [ ] no coverage regression
## Risks & Rollback
- **Breaking?** yes / no
- **Rollback**: revert this commit; no migration needed
- **Risk level**: low / medium / high — because ___
审阅检查清单规则
仅当 diff 中出现对应文件类别时,才添加相应的检查清单部分:
| 文件类别 | 检查项 |
|---|---|
| 源代码 | 无调试语句,函数 <50 行,名称清晰,错误处理 |
| 测试 | 断言有意义,覆盖边界情况,无不稳定测试,采用 AAA 模式 |
| 配置 | 无硬编码密钥,已记录环境变量,向后兼容 |
| 文档 | 内容准确,包含示例,已更新变更日志 |
安全敏感(路径中包含 auth、crypto、token、password) | 输入验证,日志中无密钥,授权正确 |
拆分大型 PR
当 diff 超过 20 个文件或 1000 行时,建议按功能领域拆分:
git checkout -b feature/part-1
git cherry-pick <commits-for-part-1>
资源
resources/implementation-playbook.md— 用于自动化 PR 分析、覆盖率报告和风险评分的 Python 辅助工具
限制
- 仅当任务明确符合上述范围时,才使用此技能。
- 不要将输出视为环境特定验证、测试或专家审查的替代品。
- 如果缺少必要的输入、权限、安全边界或成功标准,请停止并要求澄清。
证据和辅助工具限制
使用仓库现有的 PR 模板,并根据实际 diff 调整描述的详略;不要编造指标、测试、性能提升、回滚安全性或问题意图。这些 Python 代码片段只是未完成的草案:状态、类别、影响、依赖、覆盖率和 AI 辅助函数均不存在,因此在实现并运行之前,不会产生任何自动化审查结果。在相互隔离的检出目录中绑定 base/head SHA,并使用相同工具、配置和范围的兼容覆盖率数据进行比较;无法获取的覆盖率应视为未知,而不是零。风险均值、行数阈值和审阅时间估算都只是任意的参考启发式,不能凌驾于具体的严重问题或必需的审查之上。固定的架构图仅用于说明,并非推断出的证据。diff 行位置需要通过 Git hunk 映射,并处理重命名、删除和二进制文件;正则匹配和文件名分类不属于安全分析。拆分后的分支应从约定的 base 创建,而不是依次 cherry-pick 到已包含所有变更的分支上。起草描述并不授权推送分支、创建 PR、发表评论、审查或合并;应根据用户实际授予的操作权限和仓库规则执行。
评论
支持 Markdown