新增: 架构设计师代码评审职责
- 更新 SOUL.md - 添加代码评审模板 - 添加评审流程文档
This commit is contained in:
parent
2501893ab2
commit
d3ba69056b
49
architecture/code-review-process.md
Normal file
49
architecture/code-review-process.md
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
# 代码评审流程
|
||||||
|
|
||||||
|
## 概述
|
||||||
|
|
||||||
|
架构设计师负责评审前端和后端工程师提交的代码,确保代码质量和需求满足度。
|
||||||
|
|
||||||
|
## 评审触发
|
||||||
|
|
||||||
|
代码提交到 Git 仓库后,架构设计师自动收到评审通知。
|
||||||
|
|
||||||
|
## 评审标准
|
||||||
|
|
||||||
|
### 架构整洁性 (40%)
|
||||||
|
- 代码结构清晰度
|
||||||
|
- 设计模式遵循
|
||||||
|
- 模块解耦程度
|
||||||
|
- 命名规范
|
||||||
|
|
||||||
|
### 需求满足度 (40%)
|
||||||
|
- 功能实现完整性
|
||||||
|
- 边界情况处理
|
||||||
|
- 错误处理
|
||||||
|
- 性能表现
|
||||||
|
|
||||||
|
### 安全性 (20%)
|
||||||
|
- 输入验证
|
||||||
|
- 权限控制
|
||||||
|
- 数据安全
|
||||||
|
- 漏洞防护
|
||||||
|
|
||||||
|
## 评审流程
|
||||||
|
|
||||||
|
```
|
||||||
|
提交代码 → 架构师评审 → 通过/不通过 → 存档
|
||||||
|
↓
|
||||||
|
发起讨论会议 → 修复 → 重新评审
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出
|
||||||
|
|
||||||
|
每次评审生成 `architecture/code-reviews/YYYY-MM-DD-模块.md` 报告。
|
||||||
|
|
||||||
|
## 讨论会议
|
||||||
|
|
||||||
|
如评审不通过,架构师需组织讨论会议:
|
||||||
|
1. 邀请相关开发人员
|
||||||
|
2. 讨论问题解决方案
|
||||||
|
3. 记录会议结论
|
||||||
|
4. 安排修复时间
|
||||||
68
architecture/code-reviews/review-template.md
Normal file
68
architecture/code-reviews/review-template.md
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
# 代码评审报告
|
||||||
|
|
||||||
|
## 基本信息
|
||||||
|
|
||||||
|
| 项目 | 内容 |
|
||||||
|
|------|------|
|
||||||
|
| 评审日期 | |
|
||||||
|
| 评审人 | 架构设计师 |
|
||||||
|
| 被评审人 | |
|
||||||
|
| 模块 | 前端/后端 |
|
||||||
|
| 提交版本 | |
|
||||||
|
|
||||||
|
## 评审结果
|
||||||
|
|
||||||
|
### ✅ 通过 / ❌ 不通过
|
||||||
|
|
||||||
|
## 检查项
|
||||||
|
|
||||||
|
### 1. 架构整洁性
|
||||||
|
|
||||||
|
| 检查项 | 状态 | 说明 |
|
||||||
|
|--------|------|------|
|
||||||
|
| 代码结构清晰 | ✅/❌ | |
|
||||||
|
| 符合设计模式 | ✅/❌ | |
|
||||||
|
| 模块解耦合理 | ✅/❌ | |
|
||||||
|
| 命名规范统一 | ✅/❌ | |
|
||||||
|
|
||||||
|
### 2. 需求满足度
|
||||||
|
|
||||||
|
| 检查项 | 状态 | 说明 |
|
||||||
|
|--------|------|------|
|
||||||
|
| 功能符合需求 | ✅/❌ | |
|
||||||
|
| 边界情况处理 | ✅/❌ | |
|
||||||
|
| 错误处理完善 | ✅/❌ | |
|
||||||
|
| 性能达标 | ✅/❌ | |
|
||||||
|
|
||||||
|
### 3. 安全性
|
||||||
|
|
||||||
|
| 检查项 | 状态 | 说明 |
|
||||||
|
|--------|------|------|
|
||||||
|
| 输入验证 | ✅/❌ | |
|
||||||
|
| 权限控制 | ✅/❌ | |
|
||||||
|
| 数据加密 | ✅/❌ | |
|
||||||
|
| SQL注入防护 | ✅/❌ | |
|
||||||
|
|
||||||
|
## 问题列表
|
||||||
|
|
||||||
|
### 🔴 严重问题
|
||||||
|
|
||||||
|
1.
|
||||||
|
|
||||||
|
### 🟡 中等问题
|
||||||
|
|
||||||
|
1.
|
||||||
|
|
||||||
|
### 🟢 建议改进
|
||||||
|
|
||||||
|
1.
|
||||||
|
|
||||||
|
## 评审结论
|
||||||
|
|
||||||
|
-
|
||||||
|
|
||||||
|
## 后续行动
|
||||||
|
|
||||||
|
- [ ] 修复严重问题
|
||||||
|
- [ ] 修复中等问题
|
||||||
|
- [ ] 考虑建议改进
|
||||||
Loading…
Reference in New Issue
Block a user