mcpField
C
code-review

code-review

github.com/s-hiraoku测试与质量1881 次安装3 周前更新
代码仓库

关于 code-review

Code Review 是用于结构化审查代码变更、拉取请求和模块的 Agent 技能，输出可执行的反馈。它优先检查正确性与安全性，并覆盖可读性、可维护性和性能。

主要功能

  1. 01检查正确性与边界情况
  2. 02检查安全风险
  3. 03评估可读性和可维护性
  4. 04指出有实际影响的性能问题
  5. 05按严重程度组织反馈

适用场景

  1. 01合并前审查拉取请求
  2. 02审计模块中的技术债务

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/s-hiraoku/synapse-a2a --skill code-review

安装后在 Claude Code 中输入/code-review确认已加载。

详细介绍

代码审查

执行结构化、可操作的代码审查。

适用场景

  • 审查拉取请求或一组变更
  • 在合并前评估代码质量
  • 审查模块中的技术债务
  • 制定审查标准或检查清单

审查维度

按优先级从高到低，围绕以下维度审查代码：

1. 正确性
  • 代码是否实现了其声称的功能？
  • 是否处理了边界情况？（空值、空内容、溢出、并发）
  • 是否测试了错误处理路径？
  • 测试是否覆盖了变更行为？
2. 安全性
  • 是否在系统边界验证输入？
  • 代码中是否没有机密信息（API 密钥、密码、令牌）？
  • 是否防止了 SQL／命令注入？
  • 是否进行了适当的身份验证和授权检查？
  • 如需深入分析，请参阅 security-audit 技能
3. 可读性
  • 命名是否清晰（变量、函数、类）？
  • 函数是否各司其职？
  • 是否避免了过深的嵌套（最多 3 层）？
  • 注释是否解释了“为什么”，而非“是什么”？
  • 风格是否与周围代码库保持一致？
4. 可维护性
  • 是否没有不必要的抽象？
  • 是否遵循 DRY 原则，同时不过度抽象（三次原则）？
  • 依赖是否合理？
  • 是否标明了破坏性变更？
5. 性能
  • 仅在存在实际问题时提出（热点路径、大数据量、N+1 查询）
  • 除非上下文有此要求，否则不要进行微优化

审查输出格式

按以下格式组织反馈：

## Review: <PR title or file>

### Must Fix
- [ ] **file.py:42** — [Correctness] Description of the issue and suggested fix

### Should Fix
- [ ] **file.py:78** — [Readability] Description and suggestion

### Consider
- [ ] **file.py:100** — [Performance] Optional improvement

### Positive
- file.py:15 — Good use of context manager for resource cleanup

严重程度级别：

级别含义是否合并？
必须修复错误、安全问题或契约遭到破坏阻止合并
应当修复可读性／可维护性方面的重大问题请求修改
可考虑可选改进、风格偏好附上评论后批准
正面评价值得肯定的良好模式-

指南

  1. 具体明确 - 指出准确行号，并提出具体替代方案
  2. 解释原因 - 说明“这可能导致 X，因为 Y”，而不只是“改一下”
  3. 区分风格与实质 - 使用代码检查工具自动处理风格；人工审查逻辑
  4. 限制范围 - 审查变更内容，而非整个文件（除非有此要求）
  5. 肯定良好工作 - 至少包含一条正面评价
  6. 提出建议，而非强加要求 - 使用“可以考虑使用 X”，而非“必须使用 X”（必须修复项除外）

评论

支持 Markdown