2
0

coding-standards.md 1.6 KB

编码标准和测试策略

版本信息

版本 日期 描述 作者
2.4 2025-09-20 与主架构文档版本一致 Winston
2.5 2025-09-24 更新技术栈信息,修正数据库类型 Winston
2.6 2025-09-28 添加.roo/rules规范文件引用 Claude Code

详细开发规范

本项目遵循详细的开发规范,所有规范文件位于 .roo/rules/ 目录中。详细规范请参考:开发规范文档

主要规范类别

  • 基础规范: 项目结构、技术栈、模块化组织
  • API开发规范: DTO定义、数据库操作、依赖注入
  • 高级开发规范: OpenAPI、RPC调用、日志管理
  • 实体和CRUD规范: 实体定义、前端开发、CRUD实现

现有标准合规性

  • 代码风格: TypeScript严格模式,一致的缩进和命名
  • linting规则: 已配置ESLint,支持TypeScript和React
  • 测试模式: 完整的测试框架已配置(Vitest + Testing Library + Playwright)
  • 文档风格: 代码注释良好,测试策略文档完整

增强特定标准

  • 测试框架: 使用Vitest + Testing Library + hono/testing + Playwright
  • 测试位置: __tests__ 文件夹与源码并列
  • 覆盖率目标: 核心业务逻辑 > 80%
  • 测试类型: 单元测试、集成测试、E2E测试

关键集成规则

  • 现有API兼容性: 确保测试不破坏现有API契约
  • 数据库集成: 使用测试数据库,避免污染生产数据
  • 错误处理: 测试各种错误场景和边界条件
  • 日志一致性: 测试日志格式和错误信息