docs(ai-reading): 完善AI代码检查规范文档
范围: docs/ai-reading/ 涉及文件: - README.md - step7-code-commit.md 主要改进: - 增强执行前强制性检查要求,添加明确的检查点 - 完善Step 0的执行流程和验证机制 - 强化代码提交原则,明确提交所有Git变更的规范 - 优化文档结构,提升可读性和执行指导性 - 添加更清晰的警告信息和错误示例
This commit is contained in:
@@ -19,10 +19,36 @@
|
||||
## 🎯 检查目标
|
||||
完成代码修改后的规范化提交流程,确保代码变更记录清晰、分支管理规范、提交信息符合项目标准。
|
||||
|
||||
## 🚨 重要原则:提交所有变更
|
||||
|
||||
### 核心原则
|
||||
**无论变更是何时产生的、是什么类型的,只要 Git 检测到有变更,就应该帮助用户提交!**
|
||||
|
||||
### 常见误区
|
||||
❌ **错误想法**:"这些变更不是本次代码检查产生的,所以不需要提交"
|
||||
✅ **正确做法**:检查所有 Git 变更,分析变更类型,询问用户要提交哪些文件,然后用合适的方式提交
|
||||
|
||||
### 执行流程
|
||||
1. **检查 Git 状态**:`git status` 查看所有变更文件
|
||||
2. **分析变更内容**:`git diff` 查看每个文件的具体变更
|
||||
3. **分类变更类型**:判断是功能新增、Bug修复、代码优化等
|
||||
4. **询问用户意图**:确认要提交哪些文件、提交到哪个仓库
|
||||
5. **选择提交策略**:根据变更类型选择合适的分支命名和提交信息
|
||||
6. **执行提交操作**:创建分支、暂存文件、提交、推送
|
||||
|
||||
### 变更来源不重要
|
||||
变更可能来自:
|
||||
- 本次代码检查的修改 ✓
|
||||
- 之前的功能开发 ✓
|
||||
- 其他时间的代码调整 ✓
|
||||
- 任何其他修改 ✓
|
||||
|
||||
**关键是:只要有变更,就应该提供提交服务!**
|
||||
|
||||
## 📋 执行前置条件
|
||||
- 已完成前6个步骤的代码检查和修改
|
||||
- 所有修改的文件已更新修改记录和版本信息
|
||||
- 代码能够正常运行且通过测试
|
||||
- Git 工作区有变更文件(通过 `git status` 检测)
|
||||
- 代码能够正常运行且通过测试(如适用)
|
||||
- 用户明确要提交这些变更
|
||||
|
||||
## 🚨 协作规范和范围控制
|
||||
|
||||
@@ -69,8 +95,30 @@ git diff
|
||||
git diff --cached
|
||||
```
|
||||
|
||||
### 🚨 重要:不要预判变更来源
|
||||
**AI 必须检查所有 Git 变更,不要因为变更不是"本次检查产生的"就忽略!**
|
||||
|
||||
#### 错误示例
|
||||
```
|
||||
❌ AI: "检测到 chat.gateway.ts 有变更,但这是功能新增,不是代码规范检查产生的,所以不需要提交。"
|
||||
```
|
||||
|
||||
#### 正确示例
|
||||
```
|
||||
✅ AI: "检测到以下文件有变更:
|
||||
1. chat.gateway.ts - 功能新增(添加地图切换功能)
|
||||
2. auth/login.service.ts - 代码优化
|
||||
3. chat/chat.service.ts - Bug修复
|
||||
|
||||
请问您要提交哪些文件?我可以帮您:
|
||||
- 全部提交(可以分类提交不同类型的变更)
|
||||
- 只提交部分文件
|
||||
- 按模块分别提交"
|
||||
```
|
||||
|
||||
### 2. 文件修改记录校验
|
||||
**重要**:检查每个修改文件的头部信息是否与实际修改内容一致
|
||||
**注意**:如果变更不是本次代码检查产生的,文件头部可能没有更新修改记录,这是正常的。
|
||||
只需要检查变更内容,生成准确的提交信息即可。
|
||||
|
||||
#### 校验内容包括:
|
||||
- **修改记录**:最新的修改记录是否准确描述了本次变更
|
||||
|
||||
Reference in New Issue
Block a user