规范 概述
简介
本规范文档旨在统一团队开发标准,提高代码质量和协作效率。
规范目录
| 序号 | 规范名称 | 文件路径 | 说明 |
|---|---|---|---|
| 1 | 前端规范 | docs/standard/frontend.md | 前端开发的代码风格、组件设计、目录结构等规范 |
| 2 | 后端规范 | docs/standard/backend.md | 后端开发的代码结构、接口设计、包结构等规范 |
| 3 | 数据库规范 | docs/standard/database.md | 数据库设计、SQL 编写、索引优化等规范 |
| 4 | Git 规范 | docs/standard/git.md | 代码提交、分支管理、代码审查等规范 |
| 5 | 运维规范 | docs/standard/ops.md | 部署流程、环境管理、监控告警等规范 |
| 6 | API 规范 | docs/standard/api.md | RESTful API 设计原则、请求响应格式等规范 |
| 7 | 安全规范 | docs/standard/security.md | 安全开发、认证授权、数据加密等规范 |
| 8 | 文档规范 | docs/standard/document.md | 技术文档编写、注释规范等要求 |
| 9 | 架构规范 | docs/standard/architecture.md | 系统架构设计、模块划分、基本原则等规范 |
| 10 | 日志规范 | docs/standard/logging.md | 日志记录、日志级别、日志格式等规范 |
| 11 | AI编程范式 | docs/standard/ai-paradigm.md | AI辅助编程的工具选择、质量控制、安全合规及最佳实践 |
| 12 | AI编程实践 | docs/standard/ai-practice.md | 国内主流AI编程工具的具体使用实践与案例 |
| 13 | Harness 工程 | docs/standard/harness.md | 以Trae为工具的Harness工程实践规范 |
规范使用说明
所有开发人员在开发过程中应遵循本规范文档中的要求。规范将持续更新和完善。