pr-review

# PR Review 代码审查技能

> 全面审查 Pull Request 的代码质量、安全性、性能和架构设计,提供专业的改进建议

## 快速开始

```bash
# 审查当前分支的 PR
gh pr view

# 审查指定 PR
gh pr view 6324

# 查看变更内容
gh pr diff 6324
```

## 工具集成

### 使用 gh CLI 加速审查

```bash
# 查看并审查 PR
gh pr view <number> && gh pr diff <number>

# 添加审查评论
gh pr review <number> --comment -b "我的审查意见"

# 批准 PR
gh pr review <number> --approve

# 请求修改
gh pr review <number> --request-changes
```

### 本地测试 PR

```bash
# 检出 PR 分支到本地
gh pr checkout <number>

# 运行测试
pnpm test

# 运行 lint
pnpm lint

# 类型检查
pnpm tsc --noEmit

# 启动开发服务器验证
pnpm dev
```




### 常见命令参考

```bash
# PR 信息查看
gh pr view --json title,body,author,state,files,additions,deletions

# PR diff 查看
gh pr diff
gh pr diff <number> > /tmp/pr.diff  # 保存到文件

# PR commits 查看
gh pr view --json commits --jq '.commits[].messageHeadline'

# PR checks 状态
gh pr checks

# PR 评论
gh pr comment <number> --body "评论内容"

# PR 审查提交
gh pr review <number> --approve
gh pr review <number> --request-changes
gh pr review <number> --comment -b "评论内容"

# PR 操作
gh pr merge <number> --squash  # Squash merge
gh pr close <number>           # 关闭 PR
```

## 审查流程

### 1. 信息收集阶段

自动执行以下步骤:

```bash
# 1. 获取 PR 基本信息
gh pr view --json title,body,author,state,headRefName,baseRefName,additions,deletions,files

# 2. 获取 PR 变更 diff
gh pr diff

# 3. 获取 PR 的 commit 历史
gh pr view --json commits

# 4. 检查 CI/CD 状态
gh pr checks
```

### 2. 多维度代码审查

按照以下三个维度进行系统性审查:

#### 维度 1: 代码质量标准 📐

通用的代码质量标准,适用于所有项目:

- **安全性**: 输入验证、权限检查、注入防护、敏感信息保护
- **正确性**: 错误处理、边界条件、类型安全
- **性能**: 算法复杂度、数据库优化、内存管理
- **可测试性**: 测试覆盖、测试质量、Mock 使用

📖 **详细指南**: [code-quality-standards.md](./code-quality-standards.md)

#### 维度 2: FastGPT 风格规范 🎨

FastGPT 项目特定的代码规范和约定:

- **工作流节点开发**: 类型定义、节点枚举、执行逻辑、isEntry 管理
- **API 路由开发**: 路由定义、权限验证、错误处理
- **前端组件开发**: TypeScript + React、Chakra UI、状态管理
- **数据库操作**: Model 定义、查询优化、索引设计
- **包结构与依赖**: 依赖方向、导入规范、类型导出

📖 **详细指南**: [fastgpt-style-guide.md](./fastgpt-style-guide.md)

#### 维度 3: 常见问题检查清单 🔍

快速识别和修复常见问题模式:

- **TypeScript 问题**: any 类