工程规范
1. 分支与提交
main:稳定可演示版本dev:集成分支feature/*:功能开发fix/*:缺陷修复docs/*:文档专项修改
提交信息格式:
feat: add task publish flowfix: handle judge timeout resultdocs: update grading api
2. 代码规范
- 前后端统一使用 TypeScript。
- DTO、实体、接口返回对象分离定义。
- 枚举和错误码统一放在共享包中。
- 复杂业务逻辑必须写在 Service 层,不写在 Controller 或页面组件里。
3. 文档同步规则
- 新增需求或改变边界时,先改 SRS。
- 改变接口或数据结构时,必须同步更新 API 文档和数据库设计。
- 改变部署或运行方式时,必须同步更新部署文档和环境基线。
4. 测试与质量门禁
- 每个核心模块至少具备单元测试或接口测试。
- 主链路功能提交前必须本地自测。
- 合并到
dev前必须执行冒烟检查。
5. 安全与配置
- 禁止在仓库提交真实密钥和生产配置。
- 统一维护
.env.example。 - 上传、导出、判题、成绩发布等高风险操作必须保留日志。
6. 评审要求
- 核心模块至少一名同学评审。
- 正式文档至少一名同学复核。
- 演示前做一次“文档一致性 + 主链路一致性”联查。