docs: enforce commit-push-after-comeliminate-work as mandatory step
Some checks failed
CI / Lint & TypeCheck (push) Has been cancelled
CI / Unit Tests (push) Has been cancelled
CI / Build Frontend (push) Has been cancelled
CI / Rust Check (push) Has been cancelled
CI / Security Scan (push) Has been cancelled
CI / E2E Tests (push) Has been cancelled
Some checks failed
CI / Lint & TypeCheck (push) Has been cancelled
CI / Unit Tests (push) Has been cancelled
CI / Build Frontend (push) Has been cancelled
CI / Rust Check (push) Has been cancelled
CI / Security Scan (push) Has been cancelled
CI / E2E Tests (push) Has been cancelled
CLAUDE.md §3.3 闭环工作法: 代码通过→提交→推送→文档同步 三步必须按顺序执行,不允许跳过 CLAUDE.md |8.3 收尾流程: 按步骤 A/B/C/D 强制执行
This commit is contained in:
46
CLAUDE.md
46
CLAUDE.md
@@ -133,11 +133,17 @@ desktop/src-tauri (→ kernel, skills, hands, protocols)
|
|||||||
|
|
||||||
不在根因未明时盲目堆补丁。
|
不在根因未明时盲目堆补丁。
|
||||||
|
|
||||||
### 3.3 闭环工作法
|
### 3.3 闭环工作法(强制)
|
||||||
|
|
||||||
每次改动形成完整闭环:
|
每次改动**必须**按顺序完成以下步骤,不允许跳过:
|
||||||
|
|
||||||
1. 定位问题 → 2. 建立心智模型 → 3. 最小修复 → 4. 自动验证 → 5. 记录沉淀
|
1. **定位问题** — 理解根因,不盲目堆补丁
|
||||||
|
2. **最小修复** — 只改必要的代码
|
||||||
|
3. **自动验证** — `tsc --noEmit` / `cargo check` / `vitest run` 必须通过
|
||||||
|
4. **提交推送** — 按 §11 规范提交,**立即 `git push`**,不积压
|
||||||
|
5. **文档同步** — 按 §8.3 检查并更新相关文档,提交并推送
|
||||||
|
|
||||||
|
**铁律:步骤 4 和 5 是任务完成的硬性条件。不允许"等一下再提交"或"最后一起推送"。**
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
@@ -299,17 +305,35 @@ docs/
|
|||||||
- **面向未来** - 文档要帮助未来的开发者快速理解
|
- **面向未来** - 文档要帮助未来的开发者快速理解
|
||||||
- **中文优先** - 所有面向用户的文档使用中文
|
- **中文优先** - 所有面向用户的文档使用中文
|
||||||
|
|
||||||
### 8.3 完成工作后的文档同步(强制)
|
### 8.3 完成工作后的收尾流程(强制,不可跳过)
|
||||||
|
|
||||||
每次完成功能实现、架构变更、问题修复后,**必须**同步更新以下文档:
|
每次完成功能实现、架构变更、问题修复后,**必须立即执行以下收尾**:
|
||||||
|
|
||||||
1. **CLAUDE.md** — 如果涉及项目结构、技术栈、工作流程、命令的变化
|
#### 步骤 A:文档同步(代码提交前)
|
||||||
2. **docs/features/** — 如果涉及新功能、功能变更、功能状态更新
|
|
||||||
3. **docs/knowledge-base/** — 如果涉及新知识、故障排查经验、配置说明
|
|
||||||
4. **saas-config.toml 注释** — 如果涉及 SaaS 配置项变更
|
|
||||||
5. **CHANGELOG** — 如果涉及对外可见的行为变化
|
|
||||||
|
|
||||||
**执行时机:** 代码编译通过且验证成功后,在标记任务完成之前,立即执行文档更新。文档更新是任务完成的必要条件,不是可选步骤。
|
检查以下文档是否需要更新,有变更则立即修改:
|
||||||
|
|
||||||
|
1. **CLAUDE.md** — 项目结构、技术栈、工作流程、命令变化时
|
||||||
|
2. **docs/features/** — 功能状态变化时
|
||||||
|
3. **docs/knowledge-base/** — 新的排查经验或配置说明
|
||||||
|
4. **docs/TRUTH.md** — 数字(命令数、Store 数、crates 数等)变化时
|
||||||
|
|
||||||
|
#### 步骤 B:提交(按逻辑分组)
|
||||||
|
|
||||||
|
```
|
||||||
|
代码变更 → 一个或多个逻辑提交
|
||||||
|
文档变更 → 独立提交(如果和代码分开更清晰)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 步骤 C:推送(立即)
|
||||||
|
|
||||||
|
```
|
||||||
|
git push
|
||||||
|
```
|
||||||
|
|
||||||
|
**不允许积压。** 每次完成一个独立工作单元后立即推送。不要留到"最后一起推"。
|
||||||
|
|
||||||
|
**判断标准:** 如果工作目录有未提交文件,说明收尾流程没完成。
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user