代码审查 reviewing-code

这是一个用于软件开发流程中代码质量控制的技能。它提供了一套标准化的代码审查流程、快速命令和检查清单,帮助开发者高效地进行代码评审、确保代码规范、发现潜在问题并提升代码质量。关键词:代码审查,代码评审,PR检查,代码质量,软件开发流程,Git命令,自动化检查。

测试 0 次安装 0 次浏览 更新于 3/2/2026

name: 代码审查 description: 用于审查代码变更、检查PR或评估代码质量时使用。

代码审查

快速命令

# 一次性运行所有检查(测试 + 代码规范)
bpsai-pair ci

# 验证项目结构
bpsai-pair validate

# 查看变更内容
git diff main...HEAD --stat
git diff main...HEAD

审查输出格式

## 代码审查:[描述]

### 摘要
简要评估。

### 必须修复
1. **[文件:行号]** - 问题及修复方法

### 建议修复
1. **[文件:行号]** - 建议

### 可考虑
1. **[文件:行号]** - 可选改进

### 积极方面
- 做得好的地方

### 结论
- [ ] 批准
- [ ] 批准并附评论
- [ ] 请求修改

项目特定检查项

  • 公共函数需有类型提示
  • 公共接口需有文档字符串
  • 避免硬编码值(使用配置)
  • 为新功能编写测试
  • 模拟外部服务(Trello, GitHub APIs)
  • 遵循代码库现有模式

快速检查

# 查找调试语句
git diff main...HEAD | grep -E "print\(|breakpoint|pdb"

# 查找变更中的待办事项
git diff main...HEAD --name-only | xargs grep -n "TODO\|FIXME"

# 检查是否存在密钥
git diff main...HEAD | grep -iE "password|secret|api.?key|token"