Skip to main content

开发规范

社区所有项目都是基于github驱动,遵守github的流程和管理理念。

Branch 规范

目标 统一社区和开发者代码库的分支管理。 代码仓库 社区仓库 由社区成员在github上创建的代码仓库。这个仓库只维护main分支和定期发布的tag分支。tag分支命名: v<主版本>....

Merge 规范

目标 开发者使用Github完成代码合并。 合并流程 登陆github,fork社区仓库中项目到个人仓库。 克隆个人仓库代码到本地。 本地开发完成后并提交代码到个人仓库。 登陆g...

Issue 规范

创建 .github/ISSUE_TEMPLATE/ 目录,功能需求模板 (feature_request.md) 功能描述 简要描述这个功能是什么 业务价值 为什么需要这个功能?解决什...

Bug 描述规范

Bug 描述 简要描述问题 复现步骤 1. 进入... 2. 点击... 3. 看到... 预期行为 应该发生什么 实际行为 实际发生了什么 环境信息 浏览器/设备: ...

Formatter 规范

目标 统一代码风格,避免合并时出现大量格式化变更 统一IDE格式 建议使用visual studio code作为IDE工具,有丰富的插件,并支持各种主流开发语言。 统一换行符 ...

Commit 规范

目标 规范开发者每次提交本地代码到远程仓库 提交信息结构 统一格式: <type>(scope?): <short summary> [optional body] [opt...

Interface 规范

目标 规范定义和使用服务接口。 接口分类 每个服务有且只有这三类接口:公开接口(public)、运营接口(admin)、内部接口(internal)。每个接口对应属于某类接口,不会同时属于...

Readme 规范

 README.md 应包含以下章节: 项目名称 项目简介 功能特性 快速开始 环境要求 安装步骤 配置说明 本地开发 开发环境搭建 运行项目 调试方法 生产部署 部署...

Logger 规范