
关于
全面代码审查与 PR 增强
name: comprehensive-review-pr-enhance description: > 从 diff 生成结构化的 PR 描述,添加审查清单、 风险评估和测试覆盖率摘要。当用户说 "写一个 PR 描述"、"改进这个 PR"、"总结我的更改"、 "PR 审查"、"pull request",或要求为审查者记录 diff 时使用。 risk: unknown source: community
Pull Request 增强
何时使用
- 你需要将 git diff 转换为对审查者友好的 pull request 描述。
- 你想要一个包含变更分类、风险、测试说明和清单的 PR 摘要。
- diff 足够大,审查者需要明确的结构而不是简短的临时摘要。
工作流程
- 运行
git diff <base>...HEAD --stat来识别变更文件和范围 - 对变更进行分类:源代码、测试、配置、文档、构建、样式
- 使用下面的模板生成 PR 描述
- 根据变更的文件类别添加审查清单
- 标记破坏性变更、安全敏感文件或大型 diff(>500 行)
PR 描述模板
## Summary
<!-- one-paragraph executive summary: what changed and why -->
## 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
<!-- link to issue/ticket + one sentence on motivation -->
## 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 辅助工具
限制
- 仅在任务明确匹配上述描述的范围时使用此技能。
- 不要将输出视为特定环境验证、测试或专家审查的替代品。
- 如果缺少所需的输入、权限、安全边界或成功标准,请停下来要求澄清。
兼容工具
Claude CodeCursor
标签
安全
