Skip to content

规范 概述

简介

本规范文档旨在统一团队开发标准,提高代码质量和协作效率。

规范目录

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

规范使用说明

所有开发人员在开发过程中应遵循本规范文档中的要求。规范将持续更新和完善。

Released under the MIT License.