Skip to content

Commit 12f9a27

Browse files
myshkin451claude
andcommitted
docs: 完善 CLAUDE.md 工作流和 refactor-plan 重构计划
- CLAUDE.md: 添加跨 session 工作流、commit 规范、本地验证清单 - refactor-plan.md: 重写为带 checkbox 进度追踪的版本, 增加每阶段验证标准、当前进度区块、备注区 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent fa8190c commit 12f9a27

2 files changed

Lines changed: 374 additions & 298 deletions

File tree

CLAUDE.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,3 +163,61 @@ User ─┬─< Post >─── Category
163163
- 存在死代码:testDb.js, HelloWorld.vue, fixSlugs.js
164164
- ArticleCard.vue 和 ArticleCardV2.vue 重复组件
165165
- 大量 console.log 残留
166+
- 后端 package.json 混入前端依赖(ByteMD 等)
167+
168+
### 部署
169+
- 原阿里云 ECS 已过期,当前无运行环境
170+
- CI/CD deploy 阶段会失败(已改为仅手动触发)
171+
- 无数据库迁移策略(开发环境用 `{ alter: true }` 同步)
172+
173+
---
174+
175+
## 重构工作流(跨 Session 协作)
176+
177+
本项目采用分阶段重构,每个阶段在独立 session 中完成,以控制上下文长度。
178+
完整计划见 `docs/refactor-plan.md`
179+
180+
### 每个 Session 的标准流程
181+
182+
1. **读取计划** — 打开 `docs/refactor-plan.md`,定位"当前进度"区块
183+
2. **审查范围** — 阅读相关源码,理解当前状态
184+
3. **确认方案** — 向用户说明本次要做什么,获得同意后再动手
185+
4. **执行修改** — 按计划实施
186+
5. **本地验证** — 确认改动不破坏现有功能(见下方验证清单)
187+
6. **Git commit** — 验证通过后自动提交,无需用户手动要求
188+
7. **更新计划** — 在 `refactor-plan.md` 中勾选已完成项,更新"当前进度"区块指向下一步
189+
190+
### Commit 规范
191+
192+
每个步骤完成并验证通过后,**自动执行 git commit**,不需要用户额外指示。
193+
194+
- 格式:`refactor(阶段X.Y): 简要描述`
195+
- 示例:`refactor(0.1): 禁用 CI/CD 自动触发,改为手动`
196+
- 如果一个步骤改动量大,可以拆分为多次 commit
197+
- 更新 `refactor-plan.md` 的勾选状态也包含在同一次 commit 中
198+
199+
### 本地验证清单
200+
201+
每个步骤完成后,根据改动范围选择对应验证方式:
202+
203+
| 改动范围 | 验证方式 |
204+
|----------|----------|
205+
| 后端代码 | `npm run dev` 能启动,核心 API 响应正常 |
206+
| 前端代码 | `cd client && npm run dev` 能启动,页面可访问 |
207+
| Docker 配置 | `docker compose -f docker-compose.dev.yml up --build` 全部服务正常 |
208+
| 仅删文件/改配置 | `npm run dev``npm run build` 无报错即可 |
209+
| 数据库模型 | 启动后 Sequelize 同步无报错,Adminer 中表结构正确 |
210+
211+
如果本地没有 MySQL,优先用 Docker 方式验证。验证结果记录在 `refactor-plan.md` 对应步骤的备注区。
212+
213+
### Session 开始时的 Prompt 模板
214+
215+
```
216+
读 docs/refactor-plan.md,继续重构。
217+
```
218+
219+
### 注意事项
220+
- 每次修改前先读相关文件,不要凭记忆改代码
221+
- 重构过程中如果发现计划需要调整,先更新 refactor-plan.md 再继续
222+
- 如果某步骤完成后发现下一步的前置条件有变,在备注中说明
223+
- 验证失败时先修复再 commit,不要提交有问题的代码

0 commit comments

Comments
 (0)