docs: 更新 claude.md / agents.md

This commit is contained in:
Wenjie Zhang 2026-05-07 12:02:28 +08:00
parent bb8897ce28
commit 57c744dabc
2 changed files with 16 additions and 0 deletions

View File

@ -81,6 +81,13 @@ Strong success criteria let you loop independently. Weak criteria ("make it work
2. 开发完成之后必须进行 检查 -> 测试 -> Lint以及端到端测试测试脚本不完善时应完善脚本。
3. 测试规范务必遵守 [testing-guidelines.md](docs/develop-guides/testing-guidelines.md) 中的规范,测试脚本务必放在 backend/test 目录下,并且在提交前确保测试通过。
### 需求沟通规范
在沟通需求的时候,当需求不明确的时候,需要主动挖掘需求细节,对齐需求的验收标准,明确需求的优先级和范围,避免模糊需求导致的过度设计和不必要的工作。
- 需求/修改 明确之后,如果改动较大,则需要在 docs/vibe 目录下创建一个包含日期的文档,记录需求的细节和验收标准
- 该需求文档中,还应该包括本次任务的目标以及 checklist简要
### 前端开发规范
- 使用 pnpm 管理
- API 接口规范:所有的 API 接口都应该定义在 web/src/apis 下面

View File

@ -81,6 +81,13 @@ Strong success criteria let you loop independently. Weak criteria ("make it work
2. 开发完成之后必须进行 检查 -> 测试 -> Lint以及端到端测试测试脚本不完善时应完善脚本。
3. 测试规范务必遵守 [testing-guidelines.md](docs/develop-guides/testing-guidelines.md) 中的规范,测试脚本务必放在 backend/test 目录下,并且在提交前确保测试通过。
### 需求沟通规范
在沟通需求的时候,当需求不明确的时候,需要主动挖掘需求细节,对齐需求的验收标准,明确需求的优先级和范围,避免模糊需求导致的过度设计和不必要的工作。
- 需求/修改 明确之后,如果改动较大,则需要在 docs/vibe 目录下创建一个包含日期的文档,记录需求的细节和验收标准
- 该需求文档中,还应该包括本次任务的目标以及 checklist简要
### 前端开发规范
- 使用 pnpm 管理
- API 接口规范:所有的 API 接口都应该定义在 web/src/apis 下面
@ -101,6 +108,8 @@ make format # 格式化代码
- 尽量使用较新的语法,避免使用旧版本的语法(版本兼容到 3.12+
- 更新 [roadmap.md](docs/develop-guides/roadmap.md) 文档记录本次修改,多个类似的功能更新已经补充在一起
- 开发完成后务必在 docker 中进行测试,可以读取 .env 获取管理员账户和密码
- 不允许把代码写得稀碎:不要为简单线性逻辑拆出一堆细碎 helper优先写成职责清晰、结构完整、可一眼读懂的实现。
- 拆函数必须服务于明确的复用、隔离副作用或降低认知负担;如果拆分后调用链更绕、上下文更分散,就应合并回更直接的实现。
**其他**