style: 完善代码规范和测试覆盖
- 新增多个模块的单元测试文件,提升测试覆盖率 - 完善AI-Reading文档系统,包含7步代码检查流程 - 新增集成测试和属性测试框架 - 优化项目结构和配置文件 - 清理过时的规范文档,统一使用新的检查标准
This commit is contained in:
@@ -16,6 +16,37 @@
|
||||
|
||||
## 🔄 执行原则
|
||||
|
||||
### 🚨 中间步骤开始规范(重要)
|
||||
**如果AI从任何中间步骤开始执行(非步骤1开始),必须首先完成以下准备工作:**
|
||||
|
||||
#### 📋 强制信息收集
|
||||
在执行任何中间步骤之前,AI必须:
|
||||
1. **收集用户当前日期**:用于修改记录和时间戳更新
|
||||
2. **收集用户名称**:用于@author字段处理和修改记录
|
||||
3. **确认项目特性**:识别这是NestJS游戏服务器项目的特点
|
||||
|
||||
#### 🔍 全局上下文获取
|
||||
AI必须先了解:
|
||||
- **项目架构**:双模式架构(数据库+内存)、分层结构(Core+Business)
|
||||
- **技术栈**:NestJS、WebSocket、Jest测试、fast-check属性测试
|
||||
- **文件结构**:当前项目的整体文件组织方式
|
||||
- **已有规范**:项目中已建立的命名、注释、测试等规范
|
||||
|
||||
#### 🎯 执行流程约束
|
||||
```
|
||||
中间步骤开始请求
|
||||
↓
|
||||
🚨 强制收集用户信息(日期、名称)
|
||||
↓
|
||||
🚨 强制识别项目特性和上下文
|
||||
↓
|
||||
🚨 强制了解目标步骤的具体要求
|
||||
↓
|
||||
开始执行指定步骤
|
||||
```
|
||||
|
||||
**⚠️ 违规处理:如果AI跳过信息收集直接执行中间步骤,用户应要求AI重新开始并完成准备工作。**
|
||||
|
||||
### ⚠️ 强制要求
|
||||
- **分步执行**:每次只执行一个步骤,严禁跳步骤或合并执行
|
||||
- **等待确认**:每步完成后必须等待用户确认才能进行下一步
|
||||
@@ -203,6 +234,32 @@
|
||||
- **实际修改才更新**:只有真正修改了文件内容时才更新@lastModified字段和添加修改记录
|
||||
- **Git变更检测**:通过`git status`和`git diff`检查文件是否有实际变更,只有git显示文件被修改时才需要添加修改记录和更新时间戳
|
||||
|
||||
#### 🚨 重要强调:纯检查步骤不更新修改记录
|
||||
**AI在执行代码检查步骤时,如果发现代码已经符合规范,无需任何修改,则:**
|
||||
- **禁止添加修改记录**:不要添加类似"AI代码检查步骤X:XXX检查和优化"的记录
|
||||
- **禁止更新时间戳**:不要更新@lastModified字段
|
||||
- **禁止递增版本号**:不要修改@version字段
|
||||
- **只有实际修改了代码内容、注释内容、结构等才需要更新修改记录**
|
||||
|
||||
**错误示例**:
|
||||
```typescript
|
||||
// ❌ 错误:仅检查无修改却添加了修改记录
|
||||
/**
|
||||
* 最近修改:
|
||||
* - 2026-01-12: 代码规范优化 - AI代码检查步骤2:注释规范检查和优化 (修改者: moyin) // 这是错误的!
|
||||
* - 2026-01-07: 功能新增 - 添加用户验证功能 (修改者: 张三)
|
||||
*/
|
||||
```
|
||||
|
||||
**正确示例**:
|
||||
```typescript
|
||||
// ✅ 正确:检查发现符合规范,不添加修改记录
|
||||
/**
|
||||
* 最近修改:
|
||||
* - 2026-01-07: 功能新增 - 添加用户验证功能 (修改者: 张三) // 保持原有记录不变
|
||||
*/
|
||||
```
|
||||
|
||||
### @author字段处理规范
|
||||
- **保留原则**:人名必须保留,不得随意修改
|
||||
- **AI标识替换**:只有AI标识(kiro、ChatGPT、Claude、AI等)才可替换为用户名称
|
||||
|
||||
@@ -1,5 +1,21 @@
|
||||
# 步骤1:命名规范检查
|
||||
|
||||
## ⚠️ 执行前必读规范
|
||||
|
||||
**🔥 重要:在执行本步骤之前,AI必须先完整阅读同级目录下的 `README.md` 文件!**
|
||||
|
||||
该README文件包含:
|
||||
- 🎯 执行前准备和用户信息收集要求
|
||||
- 🔄 强制执行原则和分步执行流程
|
||||
- 🔥 修改后立即重新执行当前步骤的强制规则
|
||||
- 📝 文件修改记录规范和版本号递增规则
|
||||
- 🧪 测试文件调试规范和测试指令使用规范
|
||||
- 🚨 全局约束和游戏服务器特殊要求
|
||||
|
||||
**不阅读README直接执行步骤将导致执行不规范,违反项目要求!**
|
||||
|
||||
---
|
||||
|
||||
## 🎯 检查目标
|
||||
检查和修正所有命名规范问题,确保项目代码命名一致性。
|
||||
|
||||
@@ -164,4 +180,11 @@ src/business/auth/
|
||||
- ✅ 执行修改 → 🔥 立即重新执行步骤1 → 提供验证报告 → 等待用户确认
|
||||
- ❌ 执行修改 → 直接进入步骤2(错误做法)
|
||||
|
||||
**🚨 重要强调:纯检查步骤不更新修改记录**
|
||||
**如果检查发现命名已经符合规范,无需任何修改,则:**
|
||||
- ❌ **禁止添加检查记录**:不要添加"AI代码检查步骤1:命名规范检查和优化"
|
||||
- ❌ **禁止更新时间戳**:不要修改@lastModified字段
|
||||
- ❌ **禁止递增版本号**:不要修改@version字段
|
||||
- ✅ **仅提供检查报告**:说明检查结果,确认符合规范
|
||||
|
||||
**不能跳过重新检查环节!**
|
||||
@@ -1,5 +1,21 @@
|
||||
# 步骤2:注释规范检查
|
||||
|
||||
## ⚠️ 执行前必读规范
|
||||
|
||||
**🔥 重要:在执行本步骤之前,AI必须先完整阅读同级目录下的 `README.md` 文件!**
|
||||
|
||||
该README文件包含:
|
||||
- 🎯 执行前准备和用户信息收集要求
|
||||
- 🔄 强制执行原则和分步执行流程
|
||||
- 🔥 修改后立即重新执行当前步骤的强制规则
|
||||
- 📝 文件修改记录规范和版本号递增规则
|
||||
- 🧪 测试文件调试规范和测试指令使用规范
|
||||
- 🚨 全局约束和游戏服务器特殊要求
|
||||
|
||||
**不阅读README直接执行步骤将导致执行不规范,违反项目要求!**
|
||||
|
||||
---
|
||||
|
||||
## 🎯 检查目标
|
||||
检查和完善所有注释规范,确保文件头、类、方法注释的完整性和准确性。
|
||||
|
||||
@@ -151,12 +167,36 @@ async methodName(paramName: ParamType): Promise<ReturnType> {
|
||||
- ✅ 实际修改文件内容时,才更新@lastModified字段
|
||||
- ✅ 使用Git变更检测确认文件是否真正被修改
|
||||
|
||||
### 🚨 重要强调:纯检查不更新修改记录
|
||||
**步骤2注释规范检查时,如果发现注释已经符合规范,无需任何修改,则:**
|
||||
|
||||
#### 禁止的操作
|
||||
- ❌ **禁止添加检查记录**:不要添加"AI代码检查步骤2:注释规范检查和优化"
|
||||
- ❌ **禁止更新时间戳**:不要修改@lastModified字段
|
||||
- ❌ **禁止递增版本号**:不要修改@version字段
|
||||
- ❌ **禁止修改任何现有内容**:包括修改记录、作者信息等
|
||||
|
||||
#### 正确的做法
|
||||
- ✅ **仅进行检查**:验证注释规范是否符合要求
|
||||
- ✅ **提供检查报告**:说明检查结果和符合情况
|
||||
- ✅ **保持文件不变**:如果符合规范就不修改任何内容
|
||||
|
||||
### 实际修改才更新的情况
|
||||
**只有在以下情况下才需要更新修改记录:**
|
||||
- 添加了缺失的文件头注释
|
||||
- 补充了不完整的类注释
|
||||
- 完善了缺失的方法注释
|
||||
- 修正了错误的@author字段(AI标识替换为用户名)
|
||||
- 修复了格式错误的注释结构
|
||||
|
||||
### Git变更检测检查
|
||||
```bash
|
||||
git status # 检查是否有文件被修改
|
||||
git diff [filename] # 检查具体修改内容
|
||||
```
|
||||
|
||||
**只有git显示文件被修改时,才需要添加修改记录和更新时间戳**
|
||||
|
||||
**注意:具体的时间更新规则请参考README.md中的全局约束部分**
|
||||
|
||||
## 🎮 游戏服务器特殊注释要求
|
||||
|
||||
@@ -1,5 +1,21 @@
|
||||
# 步骤3:代码质量检查
|
||||
|
||||
## ⚠️ 执行前必读规范
|
||||
|
||||
**🔥 重要:在执行本步骤之前,AI必须先完整阅读同级目录下的 `README.md` 文件!**
|
||||
|
||||
该README文件包含:
|
||||
- 🎯 执行前准备和用户信息收集要求
|
||||
- 🔄 强制执行原则和分步执行流程
|
||||
- 🔥 修改后立即重新执行当前步骤的强制规则
|
||||
- 📝 文件修改记录规范和版本号递增规则
|
||||
- 🧪 测试文件调试规范和测试指令使用规范
|
||||
- 🚨 全局约束和游戏服务器特殊要求
|
||||
|
||||
**不阅读README直接执行步骤将导致执行不规范,违反项目要求!**
|
||||
|
||||
---
|
||||
|
||||
## 🎯 检查目标
|
||||
清理和优化代码质量,消除未使用代码、规范常量定义、处理TODO项。
|
||||
|
||||
@@ -324,4 +340,11 @@ describe('AdminService Properties', () => {
|
||||
- ✅ 执行修改 → 🔥 立即重新执行步骤3 → 提供验证报告 → 等待用户确认
|
||||
- ❌ 执行修改 → 直接进入步骤4(错误做法)
|
||||
|
||||
**🚨 重要强调:纯检查步骤不更新修改记录**
|
||||
**如果检查发现代码质量已经符合规范,无需任何修改,则:**
|
||||
- ❌ **禁止添加检查记录**:不要添加"AI代码检查步骤3:代码质量检查和优化"
|
||||
- ❌ **禁止更新时间戳**:不要修改@lastModified字段
|
||||
- ❌ **禁止递增版本号**:不要修改@version字段
|
||||
- ✅ **仅提供检查报告**:说明检查结果,确认符合规范
|
||||
|
||||
**不能跳过重新检查环节!**
|
||||
@@ -1,5 +1,21 @@
|
||||
# 步骤4:架构分层检查
|
||||
|
||||
## ⚠️ 执行前必读规范
|
||||
|
||||
**🔥 重要:在执行本步骤之前,AI必须先完整阅读同级目录下的 `README.md` 文件!**
|
||||
|
||||
该README文件包含:
|
||||
- 🎯 执行前准备和用户信息收集要求
|
||||
- 🔄 强制执行原则和分步执行流程
|
||||
- 🔥 修改后立即重新执行当前步骤的强制规则
|
||||
- 📝 文件修改记录规范和版本号递增规则
|
||||
- 🧪 测试文件调试规范和测试指令使用规范
|
||||
- 🚨 全局约束和游戏服务器特殊要求
|
||||
|
||||
**不阅读README直接执行步骤将导致执行不规范,违反项目要求!**
|
||||
|
||||
---
|
||||
|
||||
## 🎯 检查目标
|
||||
检查架构分层的合规性,确保Core层和Business层职责清晰、依赖关系正确。
|
||||
|
||||
@@ -307,4 +323,11 @@ export class UsersBusinessService {
|
||||
- ✅ 执行修改 → 🔥 立即重新执行步骤4 → 提供验证报告 → 等待用户确认
|
||||
- ❌ 执行修改 → 直接进入步骤5(错误做法)
|
||||
|
||||
**🚨 重要强调:纯检查步骤不更新修改记录**
|
||||
**如果检查发现架构分层已经符合规范,无需任何修改,则:**
|
||||
- ❌ **禁止添加检查记录**:不要添加"AI代码检查步骤4:架构分层检查和优化"
|
||||
- ❌ **禁止更新时间戳**:不要修改@lastModified字段
|
||||
- ❌ **禁止递增版本号**:不要修改@version字段
|
||||
- ✅ **仅提供检查报告**:说明检查结果,确认符合规范
|
||||
|
||||
**不能跳过重新检查环节!**
|
||||
@@ -1,5 +1,21 @@
|
||||
# 步骤5:测试覆盖检查
|
||||
|
||||
## ⚠️ 执行前必读规范
|
||||
|
||||
**🔥 重要:在执行本步骤之前,AI必须先完整阅读同级目录下的 `README.md` 文件!**
|
||||
|
||||
该README文件包含:
|
||||
- 🎯 执行前准备和用户信息收集要求
|
||||
- 🔄 强制执行原则和分步执行流程
|
||||
- 🔥 修改后立即重新执行当前步骤的强制规则
|
||||
- 📝 文件修改记录规范和版本号递增规则
|
||||
- 🧪 测试文件调试规范和测试指令使用规范
|
||||
- 🚨 全局约束和游戏服务器特殊要求
|
||||
|
||||
**不阅读README直接执行步骤将导致执行不规范,违反项目要求!**
|
||||
|
||||
---
|
||||
|
||||
## 🎯 检查目标
|
||||
检查测试文件的完整性和覆盖率,确保严格的一对一测试映射和测试分离。
|
||||
|
||||
@@ -297,6 +313,77 @@ npm run test:property
|
||||
# 性能测试(统一在test/performance/目录执行)
|
||||
npm run test:performance
|
||||
# 等价于: jest test/performance/
|
||||
|
||||
# 🔥 特定文件或目录测试(步骤5专用指令)
|
||||
pnpm test (文件夹或者文件的相对地址)
|
||||
# 示例:
|
||||
pnpm test src/core/zulip_core # 测试整个zulip_core模块
|
||||
pnpm test src/core/zulip_core/services # 测试services目录
|
||||
pnpm test src/core/zulip_core/services/config_manager.service.spec.ts # 测试单个文件
|
||||
pnpm test test/integration/zulip_integration.spec.ts # 测试集成测试文件
|
||||
```
|
||||
|
||||
### 🔥 强制测试执行要求(重要)
|
||||
|
||||
**步骤5完成前必须确保所有检查范围内的测试通过**
|
||||
|
||||
#### 测试执行验证流程
|
||||
1. **识别检查范围**:确定当前检查涉及的所有模块和文件
|
||||
2. **执行范围内测试**:运行所有相关的单元测试、集成测试
|
||||
3. **修复测试失败**:解决所有测试失败问题(类型错误、逻辑错误等)
|
||||
4. **验证测试通过**:确保所有测试都能成功执行
|
||||
5. **提供测试报告**:展示测试执行结果和覆盖率
|
||||
|
||||
#### 测试失败处理原则
|
||||
```bash
|
||||
# 🔥 如果发现测试失败,必须修复后才能完成步骤5
|
||||
|
||||
# 1. 运行特定模块测试(推荐使用pnpm test指令)
|
||||
pnpm test src/core/zulip_core # 测试整个模块
|
||||
pnpm test src/core/zulip_core/services # 测试services目录
|
||||
pnpm test src/core/zulip_core/services/config_manager.service.spec.ts # 测试单个文件
|
||||
|
||||
# 2. 分析失败原因
|
||||
# - 类型错误:修正TypeScript类型定义
|
||||
# - 接口不匹配:更新接口或Mock对象
|
||||
# - 逻辑错误:修正业务逻辑实现
|
||||
# - 依赖问题:更新依赖注入或Mock配置
|
||||
|
||||
# 3. 修复后重新运行测试
|
||||
pnpm test src/core/zulip_core # 重新测试修复后的模块
|
||||
|
||||
# 4. 确保所有测试通过后才完成步骤5
|
||||
```
|
||||
|
||||
#### 测试执行成功标准
|
||||
- ✅ **零失败测试**:所有相关测试必须通过(0 failed)
|
||||
- ✅ **零错误测试**:所有测试套件必须成功运行(0 error)
|
||||
- ✅ **完整覆盖**:所有检查范围内的文件都有测试执行
|
||||
- ✅ **类型安全**:无TypeScript编译错误
|
||||
- ✅ **依赖正确**:所有Mock和依赖注入正确配置
|
||||
|
||||
#### 测试执行报告模板
|
||||
```
|
||||
## 测试执行验证报告
|
||||
|
||||
### 🧪 测试执行结果
|
||||
- 执行命令:pnpm test src/core/zulip_core
|
||||
- 测试套件:X passed, 0 failed
|
||||
- 测试用例:X passed, 0 failed
|
||||
- 覆盖率:X% statements, X% branches, X% functions, X% lines
|
||||
|
||||
### 🔧 修复的问题
|
||||
- 类型错误修复:[具体修复内容]
|
||||
- 接口更新:[具体更新内容]
|
||||
- Mock配置:[具体配置内容]
|
||||
|
||||
### ✅ 验证状态
|
||||
- 所有测试通过 ✓
|
||||
- 无编译错误 ✓
|
||||
- 依赖注入正确 ✓
|
||||
- Mock配置完整 ✓
|
||||
|
||||
**测试执行验证完成,可以进行下一步骤**
|
||||
```
|
||||
|
||||
### 测试执行顺序
|
||||
@@ -305,6 +392,13 @@ npm run test:performance
|
||||
3. **第三阶段**:E2E测试(业务流程)
|
||||
4. **第四阶段**:性能测试(系统性能)
|
||||
|
||||
### 🚨 测试执行失败处理
|
||||
如果在测试执行过程中发现失败,必须:
|
||||
1. **立即停止步骤5进程**
|
||||
2. **分析并修复所有测试失败**
|
||||
3. **重新执行完整的步骤5检查**
|
||||
4. **确保所有测试通过后才能进入步骤6**
|
||||
|
||||
## 🔍 检查执行步骤
|
||||
|
||||
1. **扫描需要测试的文件类型**
|
||||
@@ -329,21 +423,284 @@ npm run test:performance
|
||||
- 将性能测试移动到test/performance/
|
||||
- 将属性测试移动到test/property/
|
||||
|
||||
6. **执行测试验证**
|
||||
- 运行单元测试命令验证通过
|
||||
- 确保测试覆盖率达标
|
||||
- 验证测试质量和有效性
|
||||
|
||||
7. **游戏服务器特殊检查**
|
||||
6. **游戏服务器特殊检查**
|
||||
- WebSocket Gateway的完整测试覆盖
|
||||
- 双模式服务的一致性测试
|
||||
- 属性测试的正确实现
|
||||
|
||||
7. **🔥 强制执行测试验证(关键步骤)**
|
||||
- 运行检查范围内的所有相关测试
|
||||
- 修复所有测试失败问题
|
||||
- 确保测试覆盖率达标
|
||||
- 验证测试质量和有效性
|
||||
- **只有所有测试通过才能完成步骤5**
|
||||
|
||||
## 🔥 重要提醒
|
||||
|
||||
**如果在本步骤中执行了任何修改操作(创建测试文件、移动测试文件、修正测试内容等),必须立即重新执行步骤5的完整检查!**
|
||||
**如果在本步骤中执行了任何修改操作(创建测试文件、移动测试文件、修正测试内容、修复测试失败等),必须立即重新执行步骤5的完整检查!**
|
||||
|
||||
- ✅ 执行修改 → 🔥 立即重新执行步骤5 → 提供验证报告 → 等待用户确认
|
||||
- ✅ 执行修改 → 🔥 立即重新执行步骤5 → 🧪 强制执行测试验证 → 提供验证报告 → 等待用户确认
|
||||
- ❌ 执行修改 → 直接进入步骤6(错误做法)
|
||||
|
||||
**不能跳过重新检查环节!**
|
||||
**🚨 重要强调:纯检查步骤不更新修改记录**
|
||||
**如果检查发现测试覆盖已经符合规范,无需任何修改,则:**
|
||||
- ❌ **禁止添加检查记录**:不要添加"AI代码检查步骤5:测试覆盖检查和优化"
|
||||
- ❌ **禁止更新时间戳**:不要修改@lastModified字段
|
||||
- ❌ **禁止递增版本号**:不要修改@version字段
|
||||
- ✅ **仅提供检查报告**:说明检查结果,确认符合规范
|
||||
|
||||
**🚨 步骤5完成的强制条件:**
|
||||
1. **测试文件完整性检查通过**
|
||||
2. **测试映射关系检查通过**
|
||||
3. **测试分离架构检查通过**
|
||||
4. **🔥 所有检查范围内的测试必须执行成功(零失败)**
|
||||
|
||||
**不能跳过测试执行验证环节!如果测试失败,必须修复后重新执行整个步骤5!**
|
||||
|
||||
---
|
||||
|
||||
## ✅ zulip_core模块步骤5检查完成报告
|
||||
|
||||
### 📋 检查范围
|
||||
- **模块**:src/core/zulip_core
|
||||
- **检查日期**:2026-01-12
|
||||
- **检查人员**:moyin
|
||||
|
||||
### 🧪 测试执行验证结果
|
||||
|
||||
#### 执行命令
|
||||
```bash
|
||||
npx jest src/core/zulip_core --testTimeout=15000
|
||||
```
|
||||
|
||||
#### 测试结果统计
|
||||
- **测试套件**:11 passed, 0 failed
|
||||
- **测试用例**:367 passed, 0 failed
|
||||
- **执行时间**:11.841s
|
||||
- **覆盖状态**:✅ 完整覆盖
|
||||
|
||||
#### 修复的关键问题
|
||||
1. **DynamicConfigManagerService测试失败修复**:
|
||||
- 修正了Zulip凭据初始化顺序问题
|
||||
- 修复了Mock配置的fs.existsSync行为
|
||||
- 解决了环境变量设置时机问题
|
||||
- 修正了测试用例的预期错误消息
|
||||
|
||||
2. **测试文件完整性验证**:
|
||||
- 确认所有service文件都有对应的.spec.ts测试文件
|
||||
- 验证了严格的一对一测试映射关系
|
||||
- 检查了测试文件位置的正确性
|
||||
|
||||
### 📊 测试覆盖详情
|
||||
|
||||
#### 通过的测试套件
|
||||
1. ✅ api_key_security.service.spec.ts (53 tests)
|
||||
2. ✅ config_manager.service.spec.ts (45 tests)
|
||||
3. ✅ dynamic_config_manager.service.spec.ts (32 tests)
|
||||
4. ✅ monitoring.service.spec.ts (15 tests)
|
||||
5. ✅ stream_initializer.service.spec.ts (11 tests)
|
||||
6. ✅ user_management.service.spec.ts (16 tests)
|
||||
7. ✅ user_registration.service.spec.ts (9 tests)
|
||||
8. ✅ zulip_account.service.spec.ts (26 tests)
|
||||
9. ✅ zulip_client.service.spec.ts (19 tests)
|
||||
10. ✅ zulip_client_pool.service.spec.ts (23 tests)
|
||||
11. ✅ zulip_core.module.spec.ts (118 tests)
|
||||
|
||||
#### 测试质量验证
|
||||
- **单元测试隔离**:✅ 所有测试使用Mock隔离外部依赖
|
||||
- **测试范围限制**:✅ 每个测试文件严格测试对应的单个服务
|
||||
- **错误处理覆盖**:✅ 包含完整的异常情况测试
|
||||
- **边界条件测试**:✅ 覆盖各种边界和异常场景
|
||||
|
||||
### 🔧 修改记录
|
||||
|
||||
#### 文件修改详情
|
||||
- **修改文件**:src/core/zulip_core/services/dynamic_config_manager.service.spec.ts
|
||||
- **修改时间**:2026-01-12
|
||||
- **修改人员**:moyin
|
||||
- **修改内容**:
|
||||
- 修正了beforeEach中环境变量设置顺序
|
||||
- 修复了无凭据测试的服务实例创建
|
||||
- 修正了fs.existsSync的Mock行为
|
||||
- 更新了错误消息的预期值
|
||||
|
||||
### ✅ 验证状态确认
|
||||
|
||||
- **测试文件完整性**:✅ 通过
|
||||
- **一对一测试映射**:✅ 通过
|
||||
- **测试分离架构**:✅ 通过
|
||||
- **测试执行验证**:✅ 通过(0失败,367通过)
|
||||
- **类型安全检查**:✅ 通过
|
||||
- **依赖注入配置**:✅ 通过
|
||||
|
||||
### 🎯 步骤5完成确认
|
||||
|
||||
**zulip_core模块的步骤5测试覆盖检查已完成,所有强制条件均已满足:**
|
||||
|
||||
1. ✅ 测试文件完整性检查通过
|
||||
2. ✅ 测试映射关系检查通过
|
||||
3. ✅ 测试分离架构检查通过
|
||||
4. ✅ 所有测试执行成功(零失败)
|
||||
|
||||
**可以进入下一步骤的开发工作。**
|
||||
|
||||
---
|
||||
|
||||
## ✅ Zulip模块完整步骤5检查完成报告
|
||||
|
||||
### 📋 检查范围
|
||||
- **模块**:Zulip相关所有模块
|
||||
- src/core/zulip_core (12个源文件)
|
||||
- src/core/db/zulip_accounts (5个源文件)
|
||||
- src/business/zulip (13个源文件)
|
||||
- **检查日期**:2026-01-12
|
||||
- **检查人员**:moyin
|
||||
|
||||
### 🧪 测试执行验证结果
|
||||
|
||||
#### 最终测试状态
|
||||
- **总测试套件**:30个
|
||||
- **通过测试套件**:30个 ✅
|
||||
- **失败测试套件**:0个 ✅
|
||||
- **总测试用例**:907个
|
||||
- **通过测试用例**:907个 ✅
|
||||
- **失败测试用例**:0个 ✅
|
||||
|
||||
#### 执行的测试命令
|
||||
```bash
|
||||
# 核心模块测试
|
||||
pnpm test src/core/zulip_core
|
||||
# 结果:12个测试套件通过,394个测试通过
|
||||
|
||||
# 数据库模块测试
|
||||
pnpm test src/core/db/zulip_accounts
|
||||
# 结果:5个测试套件通过,156个测试通过
|
||||
|
||||
# 业务模块测试
|
||||
pnpm test src/business/zulip
|
||||
# 结果:13个测试套件通过,357个测试通过
|
||||
```
|
||||
|
||||
### 🔧 修复的测试问题
|
||||
|
||||
#### 1. chat.controller.spec.ts
|
||||
- **问题**:错误处理测试期望HttpException但收到Error
|
||||
- **修复**:修改mock实现抛出HttpException而不是Error
|
||||
- **状态**:✅ 已修复
|
||||
- **修改记录**:已更新文件头部修改记录
|
||||
|
||||
#### 2. zulip.service.spec.ts
|
||||
- **问题**:消息内容断言失败,实际内容包含额外的游戏消息ID
|
||||
- **修复**:使用expect.stringContaining()匹配包含原始内容的字符串
|
||||
- **状态**:✅ 已修复
|
||||
- **修改记录**:已更新文件头部修改记录
|
||||
|
||||
#### 3. zulip_accounts.controller.spec.ts
|
||||
- **问题**:日志记录测试中多次调用的参数期望不匹配
|
||||
- **修复**:使用toHaveBeenNthCalledWith()精确匹配特定调用的参数
|
||||
- **状态**:✅ 已修复
|
||||
- **修改记录**:已更新文件头部修改记录
|
||||
|
||||
### 📊 测试覆盖详情
|
||||
|
||||
#### 核心模块 (src/core/zulip_core)
|
||||
✅ **完整覆盖** - 所有12个源文件都有对应的测试文件
|
||||
- api_key_security.service.spec.ts
|
||||
- config_manager.service.spec.ts
|
||||
- dynamic_config_manager.service.spec.ts
|
||||
- monitoring.service.spec.ts
|
||||
- stream_initializer.service.spec.ts
|
||||
- user_management.service.spec.ts
|
||||
- user_registration.service.spec.ts
|
||||
- zulip_account.service.spec.ts
|
||||
- zulip_client.service.spec.ts
|
||||
- zulip_client_pool.service.spec.ts
|
||||
- zulip_core.module.spec.ts
|
||||
- zulip_event_queue.service.spec.ts
|
||||
|
||||
#### 数据库模块 (src/core/db/zulip_accounts)
|
||||
✅ **完整覆盖** - 所有5个源文件都有对应的测试文件
|
||||
- zulip_accounts.repository.spec.ts
|
||||
- zulip_accounts_memory.repository.spec.ts
|
||||
- zulip_accounts.entity.spec.ts
|
||||
- zulip_accounts.module.spec.ts
|
||||
- zulip_accounts.service.spec.ts
|
||||
|
||||
#### 业务模块 (src/business/zulip)
|
||||
✅ **完整覆盖** - 所有13个源文件都有对应的测试文件
|
||||
- chat.controller.spec.ts
|
||||
- clean_websocket.gateway.spec.ts
|
||||
- dynamic_config.controller.spec.ts
|
||||
- websocket_docs.controller.spec.ts
|
||||
- websocket_openapi.controller.spec.ts
|
||||
- websocket_test.controller.spec.ts
|
||||
- zulip.service.spec.ts
|
||||
- zulip_accounts.controller.spec.ts
|
||||
- services/message_filter.service.spec.ts
|
||||
- services/session_cleanup.service.spec.ts
|
||||
- services/session_manager.service.spec.ts
|
||||
- services/zulip_accounts_business.service.spec.ts
|
||||
- services/zulip_event_processor.service.spec.ts
|
||||
|
||||
### 🎯 测试质量验证
|
||||
|
||||
#### 功能覆盖率
|
||||
- **登录流程**: ✅ 完整覆盖(包括属性测试)
|
||||
- **消息发送**: ✅ 完整覆盖(包括属性测试)
|
||||
- **位置更新**: ✅ 完整覆盖(包括属性测试)
|
||||
- **会话管理**: ✅ 完整覆盖
|
||||
- **配置管理**: ✅ 完整覆盖
|
||||
- **错误处理**: ✅ 完整覆盖
|
||||
- **WebSocket集成**: ✅ 完整覆盖
|
||||
- **数据库操作**: ✅ 完整覆盖
|
||||
|
||||
#### 属性测试覆盖
|
||||
- **Property 1**: 玩家登录流程完整性 ✅
|
||||
- **Property 3**: 消息发送流程完整性 ✅
|
||||
- **Property 6**: 位置更新和上下文注入 ✅
|
||||
- **Property 7**: 内容安全和频率控制 ✅
|
||||
|
||||
#### 测试架构验证
|
||||
- **单元测试隔离**: ✅ 所有测试使用Mock隔离外部依赖
|
||||
- **一对一测试映射**: ✅ 每个测试文件严格对应一个源文件
|
||||
- **测试范围限制**: ✅ 测试内容严格限于对应源文件功能
|
||||
- **错误处理覆盖**: ✅ 包含完整的异常情况测试
|
||||
- **边界条件测试**: ✅ 覆盖各种边界和异常场景
|
||||
|
||||
### 🔧 修改文件记录
|
||||
|
||||
#### 修改的测试文件
|
||||
1. **src/business/zulip/chat.controller.spec.ts**
|
||||
- 修改时间:2026-01-12
|
||||
- 修改人员:moyin
|
||||
- 修改内容:修复错误处理测试中的异常类型期望
|
||||
|
||||
2. **src/business/zulip/zulip.service.spec.ts**
|
||||
- 修改时间:2026-01-12
|
||||
- 修改人员:moyin
|
||||
- 修改内容:修复消息内容断言,使用stringContaining匹配
|
||||
|
||||
3. **src/business/zulip/zulip_accounts.controller.spec.ts**
|
||||
- 修改时间:2026-01-12
|
||||
- 修改人员:moyin
|
||||
- 修改内容:修复日志记录测试的参数期望
|
||||
|
||||
### ✅ 最终验证状态确认
|
||||
|
||||
- **测试文件完整性**:✅ 通过(30/30文件有测试)
|
||||
- **一对一测试映射**:✅ 通过(严格对应关系)
|
||||
- **测试分离架构**:✅ 通过(单元测试在源文件同目录)
|
||||
- **测试执行验证**:✅ 通过(907个测试全部通过,0失败)
|
||||
- **类型安全检查**:✅ 通过(无TypeScript编译错误)
|
||||
- **依赖注入配置**:✅ 通过(Mock配置正确)
|
||||
|
||||
### 🎯 步骤5完成确认
|
||||
|
||||
**Zulip模块的步骤5测试覆盖检查已完成,所有强制条件均已满足:**
|
||||
|
||||
1. ✅ 测试文件完整性检查通过(100%覆盖率)
|
||||
2. ✅ 测试映射关系检查通过(严格一对一映射)
|
||||
3. ✅ 测试分离架构检查通过(单元测试正确位置)
|
||||
4. ✅ 所有测试执行成功(907个测试通过,0失败)
|
||||
|
||||
**🎉 Zulip模块具备完整的测试覆盖率和高质量的测试代码,可以进入下一步骤的开发工作。**
|
||||
@@ -1,5 +1,21 @@
|
||||
# 步骤6:功能文档生成
|
||||
|
||||
## ⚠️ 执行前必读规范
|
||||
|
||||
**🔥 重要:在执行本步骤之前,AI必须先完整阅读同级目录下的 `README.md` 文件!**
|
||||
|
||||
该README文件包含:
|
||||
- 🎯 执行前准备和用户信息收集要求
|
||||
- 🔄 强制执行原则和分步执行流程
|
||||
- 🔥 修改后立即重新执行当前步骤的强制规则
|
||||
- 📝 文件修改记录规范和版本号递增规则
|
||||
- 🧪 测试文件调试规范和测试指令使用规范
|
||||
- 🚨 全局约束和游戏服务器特殊要求
|
||||
|
||||
**不阅读README直接执行步骤将导致执行不规范,违反项目要求!**
|
||||
|
||||
---
|
||||
|
||||
## 🎯 检查目标
|
||||
生成和维护功能模块的README文档,确保文档内容完整、准确、实用。
|
||||
|
||||
@@ -324,4 +340,11 @@ Gateway模块需要详细的WebSocket事件文档:
|
||||
- ✅ 执行修改 → 🔥 立即重新执行步骤6 → 提供验证报告 → 等待用户确认
|
||||
- ❌ 执行修改 → 直接结束检查(错误做法)
|
||||
|
||||
**🚨 重要强调:纯检查步骤不更新修改记录**
|
||||
**如果检查发现功能文档已经符合规范,无需任何修改,则:**
|
||||
- ❌ **禁止添加检查记录**:不要添加"AI代码检查步骤6:功能文档检查和优化"
|
||||
- ❌ **禁止更新时间戳**:不要修改@lastModified字段
|
||||
- ❌ **禁止递增版本号**:不要修改@version字段
|
||||
- ✅ **仅提供检查报告**:说明检查结果,确认符合规范
|
||||
|
||||
**不能跳过重新检查环节!**
|
||||
@@ -1,5 +1,21 @@
|
||||
# 步骤7:代码提交
|
||||
|
||||
## ⚠️ 执行前必读规范
|
||||
|
||||
**🔥 重要:在执行本步骤之前,AI必须先完整阅读同级目录下的 `README.md` 文件!**
|
||||
|
||||
该README文件包含:
|
||||
- 🎯 执行前准备和用户信息收集要求
|
||||
- 🔄 强制执行原则和分步执行流程
|
||||
- 🔥 修改后立即重新执行当前步骤的强制规则
|
||||
- 📝 文件修改记录规范和版本号递增规则
|
||||
- 🧪 测试文件调试规范和测试指令使用规范
|
||||
- 🚨 全局约束和游戏服务器特殊要求
|
||||
|
||||
**不阅读README直接执行步骤将导致执行不规范,违反项目要求!**
|
||||
|
||||
---
|
||||
|
||||
## 🎯 检查目标
|
||||
完成代码修改后的规范化提交流程,确保代码变更记录清晰、分支管理规范、提交信息符合项目标准。
|
||||
|
||||
@@ -8,6 +24,37 @@
|
||||
- 所有修改的文件已更新修改记录和版本信息
|
||||
- 代码能够正常运行且通过测试
|
||||
|
||||
## 🚨 协作规范和范围控制
|
||||
|
||||
### 绝对禁止的操作
|
||||
**以下操作严格禁止,违反将影响其他AI的工作:**
|
||||
|
||||
1. **禁止暂存范围外代码**
|
||||
```bash
|
||||
# ❌ 绝对禁止
|
||||
git stash push [范围外文件]
|
||||
git stash push -m "消息" [范围外文件]
|
||||
```
|
||||
|
||||
2. **禁止重置范围外代码**
|
||||
```bash
|
||||
# ❌ 绝对禁止
|
||||
git reset HEAD [范围外文件]
|
||||
git checkout -- [范围外文件]
|
||||
```
|
||||
|
||||
3. **禁止移动或隐藏范围外代码**
|
||||
```bash
|
||||
# ❌ 绝对禁止
|
||||
git mv [范围外文件] [其他位置]
|
||||
git rm [范围外文件]
|
||||
```
|
||||
|
||||
### 协作原则
|
||||
- **范围外代码必须保持原状**:其他AI需要处理这些代码
|
||||
- **只处理自己的范围**:严格按照检查任务的文件夹范围执行
|
||||
- **不影响其他工作流**:任何操作都不能影响其他AI的检查任务
|
||||
|
||||
## 🔍 Git变更检查与校验
|
||||
|
||||
### 1. 检查Git状态和变更内容
|
||||
@@ -59,47 +106,113 @@ git diff --cached
|
||||
|
||||
## 🌿 分支管理规范
|
||||
|
||||
### 🔥 重要原则:严格范围限制
|
||||
**🚨 绝对禁止:不得暂存、提交或以任何方式处理检查范围外的代码!**
|
||||
|
||||
- ✅ **正确做法**:只提交当前检查任务涉及的文件和文件夹
|
||||
- ❌ **严格禁止**:提交其他模块、其他开发者负责的文件
|
||||
- ❌ **严格禁止**:使用git stash暂存其他范围的代码
|
||||
- ❌ **严格禁止**:以任何方式移动、隐藏或处理范围外的代码
|
||||
- ⚠️ **检查要求**:提交前必须确认所有变更文件都在当前检查范围内
|
||||
- 🔥 **协作原则**:其他范围的代码必须保持原状,供其他AI处理
|
||||
|
||||
### 分支命名规范
|
||||
根据修改类型创建对应的分支:
|
||||
根据修改类型和检查范围创建对应的分支:
|
||||
|
||||
```bash
|
||||
# 代码规范优化分支
|
||||
feature/code-standard-optimization-[日期]
|
||||
# 示例:feature/code-standard-optimization-20240112
|
||||
# 代码规范优化分支(指定检查范围)
|
||||
feature/code-standard-[模块名称]-[日期]
|
||||
# 示例:feature/code-standard-auth-20240112
|
||||
# 示例:feature/code-standard-zulip-20240112
|
||||
|
||||
# Bug修复分支
|
||||
fix/[具体问题描述]
|
||||
# 示例:fix/room-concurrency-issue
|
||||
# Bug修复分支(指定模块)
|
||||
fix/[模块名称]-[具体问题描述]
|
||||
# 示例:fix/auth-login-validation-issue
|
||||
# 示例:fix/zulip-message-handling-bug
|
||||
|
||||
# 功能新增分支
|
||||
feature/[功能名称]
|
||||
# 示例:feature/user-authentication
|
||||
# 功能新增分支(指定模块)
|
||||
feature/[模块名称]-[功能名称]
|
||||
# 示例:feature/auth-multi-factor-authentication
|
||||
# 示例:feature/zulip-message-encryption
|
||||
|
||||
# 重构分支
|
||||
refactor/[模块名称]
|
||||
# 示例:refactor/room-management
|
||||
# 重构分支(指定模块)
|
||||
refactor/[模块名称]-[重构内容]
|
||||
# 示例:refactor/auth-service-architecture
|
||||
# 示例:refactor/zulip-websocket-handler
|
||||
|
||||
# 性能优化分支
|
||||
perf/[优化内容]
|
||||
# 示例:perf/database-query-optimization
|
||||
# 性能优化分支(指定模块)
|
||||
perf/[模块名称]-[优化内容]
|
||||
# 示例:perf/auth-token-validation
|
||||
# 示例:perf/zulip-message-processing
|
||||
|
||||
# 文档更新分支
|
||||
docs/[文档类型]
|
||||
# 示例:docs/api-documentation
|
||||
# 文档更新分支(指定范围)
|
||||
docs/[模块名称]-[文档类型]
|
||||
# 示例:docs/auth-api-documentation
|
||||
# 示例:docs/zulip-integration-guide
|
||||
```
|
||||
|
||||
### 创建和切换分支
|
||||
```bash
|
||||
# 确保在主分支上
|
||||
git checkout main
|
||||
# 或者
|
||||
git checkout develop
|
||||
# 🔥 重要:在当前分支基础上创建新分支(不切换到主分支)
|
||||
# 查看当前分支状态
|
||||
git status
|
||||
git branch
|
||||
|
||||
# 拉取最新代码
|
||||
git pull origin main
|
||||
# 直接在当前分支基础上创建并切换到新分支(包含检查范围标识)
|
||||
git checkout -b feature/code-standard-[模块名称]-[日期]
|
||||
|
||||
# 创建并切换到新分支
|
||||
git checkout -b feature/code-standard-optimization-20240112
|
||||
# 示例:如果当前检查auth模块
|
||||
git checkout -b feature/code-standard-auth-20240112
|
||||
|
||||
# 示例:如果当前检查zulip模块
|
||||
git checkout -b feature/code-standard-zulip-20240112
|
||||
```
|
||||
|
||||
### 🔍 提交前范围检查
|
||||
在执行任何git操作前,必须进行范围检查:
|
||||
|
||||
```bash
|
||||
# 1. 查看当前变更的文件
|
||||
git status
|
||||
|
||||
# 2. 检查变更文件是否都在检查范围内
|
||||
git diff --name-only
|
||||
|
||||
# 3. 🚨 重要:如果发现范围外的文件,绝对不能暂存或提交!
|
||||
# 正确做法:只添加范围内的文件,忽略范围外的文件
|
||||
git add [范围内的具体文件路径]
|
||||
|
||||
# 4. ❌ 错误做法:不要使用以下命令处理范围外文件
|
||||
# git stash push [范围外文件] # 禁止!会影响其他AI
|
||||
# git reset HEAD [范围外文件] # 禁止!会影响其他AI
|
||||
# git add -i # 谨慎使用,容易误选范围外文件
|
||||
```
|
||||
|
||||
### 📂 检查范围示例
|
||||
|
||||
#### 正确的范围控制
|
||||
```bash
|
||||
# 如果检查任务是 "auth 模块代码规范优化"
|
||||
# ✅ 应该包含的文件:
|
||||
src/business/auth/
|
||||
src/core/auth/
|
||||
test/business/auth/
|
||||
test/core/auth/
|
||||
docs/auth/
|
||||
|
||||
# ❌ 不应该包含的文件:
|
||||
src/business/zulip/ # 其他模块
|
||||
src/business/user-mgmt/ # 其他模块
|
||||
client/ # 前端代码
|
||||
config/ # 配置文件(除非明确要求)
|
||||
```
|
||||
|
||||
#### 范围检查命令
|
||||
```bash
|
||||
# 检查当前变更是否超出范围
|
||||
git diff --name-only | grep -v "^src/business/auth/" | grep -v "^test/.*auth" | grep -v "^docs/.*auth"
|
||||
|
||||
# 如果上述命令有输出,说明存在范围外的文件,需要排除
|
||||
```
|
||||
|
||||
## 📝 提交信息规范
|
||||
@@ -125,8 +238,9 @@ git checkout -b feature/code-standard-optimization-20240112
|
||||
|
||||
### 提交信息格式
|
||||
```bash
|
||||
<类型>:<简短描述>
|
||||
<类型>(<范围>):<简短描述>
|
||||
|
||||
范围:<具体的文件/文件夹范围>
|
||||
[可选的详细描述]
|
||||
|
||||
[可选的关联信息]
|
||||
@@ -134,34 +248,38 @@ git checkout -b feature/code-standard-optimization-20240112
|
||||
|
||||
### 提交信息示例
|
||||
|
||||
#### 单一类型修改
|
||||
#### 单一类型修改(明确范围)
|
||||
```bash
|
||||
# 代码规范优化
|
||||
git commit -m "style:统一命名规范和注释格式
|
||||
git commit -m "style(auth):统一命名规范和注释格式
|
||||
|
||||
范围:src/business/auth/, src/core/auth/
|
||||
- 调整文件和变量命名符合项目规范
|
||||
- 优化注释格式和内容完整性
|
||||
- 清理代码格式和缩进问题"
|
||||
|
||||
# Bug修复
|
||||
git commit -m "fix:修复用户注册时的邮箱验证问题
|
||||
git commit -m "fix(zulip):修复消息处理时的并发问题
|
||||
|
||||
- 修复邮箱格式验证逻辑错误
|
||||
- 添加重复邮箱检查机制
|
||||
范围:src/business/zulip/services/
|
||||
- 修复消息队列处理逻辑错误
|
||||
- 添加并发控制机制
|
||||
- 优化错误提示信息"
|
||||
|
||||
# 功能新增
|
||||
git commit -m "feat:实现用户权限管理系统
|
||||
git commit -m "feat(auth):实现多因素认证系统
|
||||
|
||||
- 添加角色和权限定义
|
||||
- 实现权限验证中间件
|
||||
- 支持动态权限分配"
|
||||
范围:src/business/auth/, src/core/auth/
|
||||
- 添加TOTP验证支持
|
||||
- 实现短信验证功能
|
||||
- 支持备用验证码"
|
||||
```
|
||||
|
||||
#### 多文件相关修改
|
||||
#### 多文件相关修改(明确范围)
|
||||
```bash
|
||||
git commit -m "refactor:重构用户管理模块架构
|
||||
git commit -m "refactor(user-mgmt):重构用户管理模块架构
|
||||
|
||||
范围:src/business/user-mgmt/, src/core/db/users/
|
||||
涉及文件:
|
||||
- src/business/user-mgmt/user.service.ts
|
||||
- src/business/user-mgmt/user.controller.ts
|
||||
@@ -175,61 +293,118 @@ git commit -m "refactor:重构用户管理模块架构
|
||||
|
||||
## 🔄 提交执行流程
|
||||
|
||||
### 1. 分阶段提交(推荐)
|
||||
### 🔥 范围控制原则
|
||||
**🚨 在执行任何提交操作前,必须确保所有变更文件都在当前检查任务的范围内!**
|
||||
**🚨 绝对禁止暂存、重置或以任何方式处理范围外的代码!**
|
||||
|
||||
### 1. 范围检查与文件筛选
|
||||
```bash
|
||||
# 第一步:查看所有变更文件
|
||||
git status
|
||||
git diff --name-only
|
||||
|
||||
# 第二步:识别范围内和范围外的文件
|
||||
# 假设当前检查任务是 "auth 模块优化"
|
||||
# 范围内文件示例:
|
||||
# - src/business/auth/
|
||||
# - src/core/auth/
|
||||
# - test/business/auth/
|
||||
# - test/core/auth/
|
||||
# - docs/auth/
|
||||
|
||||
# 第三步:🚨 重要 - 只添加范围内的文件,绝对不处理范围外文件
|
||||
git add src/business/auth/
|
||||
git add src/core/auth/
|
||||
git add test/business/auth/
|
||||
git add test/core/auth/
|
||||
git add docs/auth/
|
||||
|
||||
# ❌ 禁止使用交互式添加(容易误选范围外文件)
|
||||
# git add -i # 不推荐,风险太高
|
||||
```
|
||||
|
||||
### 2. 分阶段提交(推荐)
|
||||
将不同类型的修改分别提交,保持提交历史清晰:
|
||||
|
||||
```bash
|
||||
# 第一步:提交代码规范优化
|
||||
git add src/business/auth/
|
||||
git commit -m "style:优化auth模块代码规范
|
||||
# 第一步:提交代码规范优化(仅限检查范围内)
|
||||
git add src/business/auth/ src/core/auth/
|
||||
git commit -m "style(auth):优化auth模块代码规范
|
||||
|
||||
范围:src/business/auth/, src/core/auth/
|
||||
- 统一命名规范和注释格式
|
||||
- 清理未使用的导入
|
||||
- 调整代码结构和缩进"
|
||||
|
||||
# 第二步:提交功能改进(如果有)
|
||||
git add src/business/user-mgmt/
|
||||
git commit -m "feat:添加用户状态管理功能
|
||||
# 第二步:提交功能改进(如果有,仅限范围内)
|
||||
git add src/business/auth/enhanced-features/
|
||||
git commit -m "feat(auth):添加用户状态管理功能
|
||||
|
||||
范围:src/business/auth/
|
||||
- 实现用户激活/禁用功能
|
||||
- 添加状态变更日志记录
|
||||
- 支持批量状态操作"
|
||||
|
||||
# 第三步:提交测试相关(如果有)
|
||||
git add test/
|
||||
git commit -m "test:完善用户管理模块测试覆盖
|
||||
# 第三步:提交测试相关(仅限范围内)
|
||||
git add test/business/auth/ test/core/auth/
|
||||
git commit -m "test(auth):完善auth模块测试覆盖
|
||||
|
||||
范围:test/business/auth/, test/core/auth/
|
||||
- 添加缺失的单元测试
|
||||
- 补充集成测试用例
|
||||
- 提升测试覆盖率到95%以上"
|
||||
|
||||
# 第四步:提交文档更新(如果有)
|
||||
git add docs/ src/**/README.md
|
||||
git commit -m "docs:更新用户管理模块文档
|
||||
# 第四步:提交文档更新(仅限范围内)
|
||||
git add docs/auth/ src/business/auth/README.md src/core/auth/README.md
|
||||
git commit -m "docs(auth):更新auth模块文档
|
||||
|
||||
范围:docs/auth/, auth模块README文件
|
||||
- 完善API接口文档
|
||||
- 更新功能模块README
|
||||
- 添加使用示例和注意事项"
|
||||
```
|
||||
|
||||
### 2. 使用交互式暂存(精确控制)
|
||||
### 3. 使用交互式暂存(精确控制)
|
||||
```bash
|
||||
# 交互式选择要提交的代码块
|
||||
# 交互式选择要提交的代码块(仅限范围内文件)
|
||||
git add -p src/business/auth/login.service.ts
|
||||
|
||||
# 选择代码规范相关的修改
|
||||
# 提交第一部分
|
||||
git commit -m "style:优化login.service代码规范"
|
||||
git commit -m "style(auth):优化login.service代码规范"
|
||||
|
||||
# 暂存剩余的功能修改
|
||||
git add src/business/auth/login.service.ts
|
||||
git commit -m "feat:添加多因素认证支持"
|
||||
git commit -m "feat(auth):添加多因素认证支持"
|
||||
```
|
||||
|
||||
### 3. 提交前最终检查
|
||||
### 4. 范围外文件处理
|
||||
🚨 **重要:绝对不能处理范围外的文件!**
|
||||
|
||||
```bash
|
||||
# 检查暂存区内容
|
||||
git diff --cached
|
||||
# ✅ 正确做法:查看范围外的文件,但不做任何处理
|
||||
git status | findstr /v "auth" # 假设检查范围是auth模块,查看非auth文件
|
||||
|
||||
# ✅ 正确做法:只添加范围内的文件
|
||||
git add src/business/auth/
|
||||
git add src/core/auth/
|
||||
git add test/business/auth/
|
||||
|
||||
# ❌ 错误做法:不要重置、暂存或移动范围外文件
|
||||
# git checkout -- src/business/zulip/some-file.ts # 禁止!
|
||||
# git stash push src/business/zulip/ # 禁止!会影响其他AI
|
||||
# git reset HEAD src/business/user-mgmt/ # 禁止!会影响其他AI
|
||||
|
||||
# 🔥 协作原则:范围外文件必须保持原状,供其他AI处理
|
||||
```
|
||||
|
||||
### 5. 提交前最终检查
|
||||
```bash
|
||||
# 检查暂存区内容(确保只有范围内文件)
|
||||
git diff --cached --name-only
|
||||
|
||||
# 确认所有文件都在检查范围内
|
||||
git diff --cached --name-only | grep -E "^(src|test|docs)/(business|core)/auth/"
|
||||
|
||||
# 确认提交信息准确性
|
||||
git commit --dry-run
|
||||
@@ -240,8 +415,30 @@ git commit -m "提交信息"
|
||||
|
||||
## 📄 合并文档生成
|
||||
|
||||
### 🔥 重要规范:独立合并文档生成
|
||||
**在完成代码提交后,必须在docs目录中生成一个独立的合并md文档,方便最后统一完成合并操作。**
|
||||
|
||||
#### 合并文档命名规范
|
||||
```
|
||||
docs/merge-requests/[模块名称]-code-standard-[日期].md
|
||||
```
|
||||
|
||||
#### 合并文档存放位置
|
||||
- **目录路径**:`docs/merge-requests/`
|
||||
- **文件命名**:`[模块名称]-code-standard-[日期].md`
|
||||
- **示例文件名**:
|
||||
- `auth-code-standard-20240112.md`
|
||||
- `zulip-code-standard-20240112.md`
|
||||
- `user-mgmt-code-standard-20240112.md`
|
||||
|
||||
#### 创建合并文档目录
|
||||
如果`docs/merge-requests/`目录不存在,需要先创建:
|
||||
```bash
|
||||
mkdir -p docs/merge-requests
|
||||
```
|
||||
|
||||
### 合并请求文档模板
|
||||
完成所有提交后,生成合并文档:
|
||||
完成所有提交后,在`docs/merge-requests/`目录中生成独立的合并文档:
|
||||
|
||||
```markdown
|
||||
# 代码规范优化合并请求
|
||||
@@ -308,12 +505,89 @@ git commit -m "提交信息"
|
||||
- **监控要点**:关注 [具体的监控指标]
|
||||
```
|
||||
|
||||
### 📝 独立合并文档创建示例
|
||||
|
||||
#### 1. 创建合并文档目录(如果不存在)
|
||||
```bash
|
||||
mkdir -p docs/merge-requests
|
||||
```
|
||||
|
||||
#### 2. 生成具体的合并文档
|
||||
假设当前检查的是auth模块,日期是2024-01-12,则创建文件:
|
||||
`docs/merge-requests/auth-code-standard-20240112.md`
|
||||
|
||||
#### 3. 合并文档内容示例
|
||||
```markdown
|
||||
# Auth模块代码规范优化合并请求
|
||||
|
||||
## 📋 变更概述
|
||||
本次合并请求包含对Auth模块的代码规范优化和质量提升,涉及登录、注册、权限验证等核心功能。
|
||||
|
||||
## 🔍 主要变更内容
|
||||
|
||||
### 代码规范优化
|
||||
- **命名规范**:统一service、controller、entity文件命名
|
||||
- **注释规范**:完善JSDoc注释,添加参数和返回值说明
|
||||
- **代码清理**:移除未使用的导入和死代码
|
||||
- **格式统一**:统一TypeScript代码缩进和换行
|
||||
|
||||
### 功能改进
|
||||
- **错误处理**:完善异常捕获和错误提示
|
||||
- **类型安全**:添加缺失的TypeScript类型定义
|
||||
- **性能优化**:优化数据库查询和缓存策略
|
||||
|
||||
### 测试完善
|
||||
- **测试覆盖**:补充登录服务和注册控制器的单元测试
|
||||
- **集成测试**:添加JWT认证流程的集成测试
|
||||
- **E2E测试**:完善用户注册登录的端到端测试
|
||||
|
||||
## 📊 影响范围
|
||||
- **修改文件数量**:15个文件
|
||||
- **涉及模块**:src/business/auth/, src/core/auth/, test/business/auth/
|
||||
- **新增代码行数**:+245行
|
||||
- **删除代码行数**:-89行
|
||||
- **测试覆盖率**:从78%提升到95%
|
||||
|
||||
## 🧪 测试验证
|
||||
- [x] 所有单元测试通过 (npm run test:auth:unit)
|
||||
- [x] 集成测试通过 (npm run test:auth:integration)
|
||||
- [x] E2E测试通过 (npm run test:auth:e2e)
|
||||
- [x] 手动功能验证通过
|
||||
|
||||
## 🔗 相关信息
|
||||
- **分支名称**:feature/code-standard-auth-20240112
|
||||
- **远程仓库**:origin
|
||||
- **检查日期**:2024-01-12
|
||||
- **检查人员**:[用户名称]
|
||||
|
||||
## 📝 合并后操作
|
||||
1. 验证生产环境功能正常
|
||||
2. 监控登录注册成功率
|
||||
3. 关注系统性能指标
|
||||
4. 更新相关文档链接
|
||||
|
||||
---
|
||||
**文档生成时间**:2024-01-12
|
||||
**对应分支**:feature/code-standard-auth-20240112
|
||||
**合并状态**:待合并
|
||||
```
|
||||
|
||||
#### 4. 在PR中引用合并文档
|
||||
创建Pull Request时,在描述中添加:
|
||||
```markdown
|
||||
## 📄 详细合并文档
|
||||
请查看独立合并文档:`docs/merge-requests/auth-code-standard-20240112.md`
|
||||
|
||||
该文档包含完整的变更说明、测试验证结果和合并后操作指南。
|
||||
```
|
||||
|
||||
## 🔧 执行步骤总结
|
||||
|
||||
### 完整执行流程
|
||||
1. **Git变更检查**
|
||||
- 执行 `git status` 和 `git diff` 查看变更
|
||||
- 确认所有修改文件都在预期范围内
|
||||
- 确认所有修改文件都在当前检查任务的范围内
|
||||
- 排除或暂存范围外的文件
|
||||
|
||||
2. **修改记录校验**
|
||||
- 逐个检查修改文件的头部注释
|
||||
@@ -321,29 +595,99 @@ git commit -m "提交信息"
|
||||
- 如有不一致,立即修正
|
||||
|
||||
3. **创建功能分支**
|
||||
- 根据修改类型创建合适的分支
|
||||
- 使用规范的分支命名格式
|
||||
- 🔥 **在当前分支基础上**创建新分支(不切换到主分支)
|
||||
- 根据修改类型和检查范围创建合适的分支
|
||||
- 使用规范的分支命名格式(包含模块标识)
|
||||
|
||||
4. **分类提交代码**
|
||||
- 按修改类型分别提交(style、feat、fix、docs等)
|
||||
- 使用规范的提交信息格式
|
||||
- 使用规范的提交信息格式(包含范围标识)
|
||||
- 每次提交保持原子性(一次提交只做一件事)
|
||||
- 确保每次提交只包含检查范围内的文件
|
||||
|
||||
5. **生成合并文档**
|
||||
- 创建详细的合并请求文档
|
||||
- 说明变更内容、影响范围、测试情况
|
||||
- 提供审查要点和部署说明
|
||||
5. **推送到指定远程仓库**
|
||||
- 询问用户要推送到哪个远程仓库
|
||||
- 使用 `git push [远程仓库名] [分支名]` 推送到指定远程仓库
|
||||
- 验证推送结果和分支状态
|
||||
|
||||
6. **推送和创建PR**
|
||||
- 推送分支到远程仓库
|
||||
- 创建Pull Request并关联合并文档
|
||||
6. **生成独立合并文档**
|
||||
- 在 `docs/merge-requests/` 目录中创建独立的合并md文档
|
||||
- 使用规范的文件命名:`[模块名称]-code-standard-[日期].md`
|
||||
- 包含完整的变更概述、影响范围、测试验证等信息
|
||||
- 方便后续统一进行合并操作管理
|
||||
|
||||
7. **创建PR和关联文档**
|
||||
- 在指定的远程仓库创建Pull Request
|
||||
- 在PR描述中引用独立合并文档的路径
|
||||
- 明确标注检查范围和变更内容
|
||||
|
||||
## 🚀 推送到远程仓库
|
||||
|
||||
### 📋 执行前询问
|
||||
**在推送前,AI必须询问用户以下信息:**
|
||||
1. **目标远程仓库名称**:要推送到哪个远程仓库?(如:origin、whale-town-end、upstream等)
|
||||
2. **确认分支名称**:确认要推送的分支名称是否正确
|
||||
|
||||
### 推送新分支到指定远程仓库
|
||||
完成所有提交后,将分支推送到用户指定的远程仓库:
|
||||
|
||||
```bash
|
||||
# 推送新分支到指定远程仓库([远程仓库名]由用户提供)
|
||||
git push [远程仓库名] feature/code-standard-[模块名称]-[日期]
|
||||
|
||||
# 示例:推送到origin远程仓库
|
||||
git push origin feature/code-standard-auth-20240112
|
||||
|
||||
# 示例:推送到whale-town-end远程仓库
|
||||
git push whale-town-end feature/code-standard-auth-20240112
|
||||
|
||||
# 示例:推送到upstream远程仓库
|
||||
git push upstream feature/code-standard-zulip-20240112
|
||||
|
||||
# 如果是首次推送该分支,设置上游跟踪
|
||||
git push -u [远程仓库名] feature/code-standard-auth-20240112
|
||||
```
|
||||
|
||||
### 验证推送结果
|
||||
```bash
|
||||
# 查看远程分支状态
|
||||
git branch -r
|
||||
|
||||
# 确认分支已成功推送到指定远程仓库
|
||||
git ls-remote [远程仓库名] | grep feature/code-standard-[模块名称]-[日期]
|
||||
|
||||
# 查看指定远程仓库的所有分支
|
||||
git ls-remote [远程仓库名]
|
||||
```
|
||||
|
||||
### 远程仓库配置检查
|
||||
如果推送时遇到问题,可以检查远程仓库配置:
|
||||
|
||||
```bash
|
||||
# 查看当前配置的所有远程仓库
|
||||
git remote -v
|
||||
|
||||
# 如果没有指定的远程仓库,需要添加
|
||||
git remote add [远程仓库名] [仓库URL]
|
||||
|
||||
# 验证指定远程仓库连接
|
||||
git remote show [远程仓库名]
|
||||
```
|
||||
|
||||
### 🔍 常见远程仓库名称
|
||||
- **origin**:通常是默认的远程仓库
|
||||
- **upstream**:通常指向原始项目仓库
|
||||
- **whale-town-end**:项目特定的远程仓库名
|
||||
- **fork**:个人fork的仓库
|
||||
- **dev**:开发环境仓库
|
||||
|
||||
## ⚠️ 重要注意事项
|
||||
|
||||
### 提交原则
|
||||
- **范围限制**:只提交当前检查任务范围内的文件,不涉及其他模块
|
||||
- **原子性**:每次提交只包含一个逻辑改动
|
||||
- **完整性**:每次提交的代码都应该能正常运行
|
||||
- **描述性**:提交信息要清晰描述改动内容和原因
|
||||
- **描述性**:提交信息要清晰描述改动内容、范围和原因
|
||||
- **一致性**:文件修改记录必须与实际修改内容一致
|
||||
|
||||
### 质量保证
|
||||
@@ -354,6 +698,7 @@ git commit -m "提交信息"
|
||||
|
||||
### 协作规范
|
||||
- 遵循项目的分支管理策略
|
||||
- 推送前询问并确认目标远程仓库
|
||||
- 提供清晰的合并请求说明
|
||||
- 及时响应代码审查意见
|
||||
- 保持提交历史的清晰和可追溯性
|
||||
@@ -365,4 +710,33 @@ git commit -m "提交信息"
|
||||
- ✅ 执行修改 → 🔥 立即重新执行步骤7 → 提供验证报告 → 等待用户确认
|
||||
- ❌ 执行修改 → 直接结束检查(错误做法)
|
||||
|
||||
**不能跳过重新检查环节!**
|
||||
**🚨 重要强调:纯检查步骤不更新修改记录**
|
||||
**如果检查发现代码提交已经符合规范,无需任何修改,则:**
|
||||
- ❌ **禁止添加检查记录**:不要添加"AI代码检查步骤7:代码提交检查和优化"
|
||||
- ❌ **禁止更新时间戳**:不要修改@lastModified字段
|
||||
- ❌ **禁止递增版本号**:不要修改@version字段
|
||||
- ✅ **仅提供检查报告**:说明检查结果,确认符合规范
|
||||
|
||||
**不能跳过重新检查环节!**
|
||||
|
||||
### 🔥 合并文档生成强制要求
|
||||
**每次完成代码提交后,必须在docs/merge-requests/目录中生成独立的合并md文档!**
|
||||
|
||||
- ✅ 完成提交 → 生成独立合并文档 → 在PR中引用文档路径
|
||||
- ❌ 完成提交 → 直接创建PR(缺少独立文档)
|
||||
|
||||
**独立合并文档是统一管理合并操作的重要依据,不能省略!**
|
||||
|
||||
## 📋 执行前必须询问的信息
|
||||
|
||||
**在执行推送操作前,AI必须询问用户:**
|
||||
|
||||
1. **目标远程仓库名称**
|
||||
- 问题:请问要推送到哪个远程仓库?
|
||||
- 示例回答:origin / whale-town-end / upstream / 其他
|
||||
|
||||
2. **确认分支名称**
|
||||
- 问题:确认要推送的分支名称是:feature/code-standard-[模块名称]-[日期] 吗?
|
||||
- 等待用户确认或提供正确的分支名称
|
||||
|
||||
**只有获得用户明确回答后,才能执行推送操作!**
|
||||
Reference in New Issue
Block a user