项目配置示例

项目概览

• 名称：电商平台
• 技术栈：Node.js、PostgreSQL、React 18、Docker
• 团队规模：5 名开发者
• 截止日期：2025 年 Q4

架构文档

@docs/architecture.md @docs/api-standards.md @docs/database-schema.md

开发规范

代码风格

• 使用 Prettier 格式化代码
• 使用 ESLint（airbnb 配置）
• 最大行长度：100 个字符
• 使用 2 空格缩进

命名规范

• 文件名：kebab-case（如 user-controller.js）
• 类名：PascalCase（如 UserService）
• 函数/变量：camelCase（如 getUserById）
• 常量：UPPER_SNAKE_CASE（如 API_BASE_URL）
• 数据库表：snake_case（如 user_accounts）

Git 工作流

• 分支命名：feature/description 或 fix/description
• 提交信息：遵循 Conventional Commits 规范
• 合并前必须提交 PR
• 所有 CI/CD 检查必须通过
• 至少需要 1 名成员审批

测试要求

• 代码覆盖率不低于 80%
• 所有关键路径必须有测试
• 单元测试使用 Jest
• E2E 测试使用 Cypress
• 测试文件名格式：*.test.ts 或 *.spec.ts

API 规范

• 仅使用 RESTful 接口
• 请求/响应均使用 JSON 格式
• 正确使用 HTTP 状态码
• API 版本化：/api/v1/
• 所有接口必须附有使用示例文档

数据库

• 使用 migration 管理 Schema 变更
• 禁止硬编码凭证信息
• 使用连接池
• 开发环境开启查询日志
• 定期备份

部署

• 基于 Docker 部署
• 使用 Kubernetes 编排
• 蓝绿发布策略
• 失败时自动回滚
• 部署前先执行数据库迁移

常用命令

命令	用途
npm run dev	启动开发服务器
npm test	运行测试套件
npm run lint	检查代码风格
npm run build	构建生产版本
npm run migrate	执行数据库迁移

团队联系人

• 技术负责人：Sarah Chen（@sarah.chen）
• 产品经理：Mike Johnson（@mike.j）
• 运维：Alex Kim（@alex.k）

已知问题与解决方案

• 高峰期 PostgreSQL 连接池限制为 20 个连接
  • 解决方案：实现查询队列
• Safari 14 对 async generator 存在兼容性问题
  • 解决方案：使用 Babel 转译

相关项目

• 数据分析看板：/projects/analytics
• 移动应用：/projects/mobile
• 管理后台：/projects/admin