27 lines
1015 B
Markdown
27 lines
1015 B
Markdown
|
# 开发规范与协作约定
|
|||
|
|
|
|||
|
|
## 1. 文档目标
|
|||
|
|
统一后续多人协作、agent 执行、代码提交和文档补充的方式，减少返工与沟通成本。
|
|||
|
|
|
|||
|
|
## 2. 命名规范建议
|
|||
|
|
- 文档：采用中文 + 编号方式命名。
|
|||
|
|
- API：统一使用资源化命名风格。
|
|||
|
|
- 数据库字段：统一小写下划线风格（建议）。
|
|||
|
|
- 状态值：优先使用枚举常量，避免散落 magic value。
|
|||
|
|
|
|||
|
|
## 3. 分支与提交建议
|
|||
|
|
- 需求变更应有对应文档更新。
|
|||
|
|
- commit message 建议使用中文并带类型前缀，例如：`feat:`、`fix:`、`docs:`、`refactor:`。
|
|||
|
|
- 接口变更需同步更新接口文档与前端调用说明。
|
|||
|
|
|
|||
|
|
## 4. 协作约定
|
|||
|
|
- 先补文档，再拆任务，再开发。
|
|||
|
|
- 核心业务规则必须在文档中确认后再编码。
|
|||
|
|
- 重要状态流转和异常处理需有测试覆盖。
|
|||
|
|
|
|||
|
|
## 5. 适合交给 agent 的任务类型
|
|||
|
|
- 页面脚手架与模块初始化
|
|||
|
|
- API 路由和 DTO 生成
|
|||
|
|
- 数据表初稿与接口联调
|
|||
|
|
- 单元测试与接口测试补齐
|