开发规范文档

# Git开发规范

# 分支管理

# master 分支

master 为主分支，也是用于部署生产环境的分支，确保master分支稳定性。

master 分支一般由develop以及hotfix分支合并，任何时间都不能直接修改代码。

# develop 分支

develop 为开发分支，始终保持最新完成的以及bug修复后的代码。

一般开发新功能时，feature分支都是基于develop分支下创建的。

# feature 分支

开发新功能时，以develop为基础创建feature分支。

分支命名：feature- 开头的为特性分支，命令规则：feature-user、feature-device。

分支命名：feature- 开头的为开发者分支，命令规则：feature-zhangsan、feature-lisi。

# release 分支

release 为预上线分支，发布提测阶段，会以release分支代码为基准提测。

当feature分支开发完成，首先会合并到develop分支，进入提测时，会以develop分支为基准创建release分支。

如果测试过程中存在bug需要修复，则直接由开发者在release分支修复并提交。

当测试完成之后，合并release分支到master和develop分支，此时master分支为最新代码，用于线上部署。

# hotfix 分支

分支命名：hotfix- 开头的为修复分支。当线上出现紧急问题时，需要及时修复，以master分支为基线，创建hotfix分支，修复完成后，合并到master和develop分支。

# 操作步骤

  • 1.管理员「项目负责人」创建git仓库，并建立develop分支
git checkout -b develop 
git push -u origin develop
1
2
  • 2.项目成员「开发者」clone项目，在本地建立自己的开发分支
git clone 项目 git 地址

拉取develop分支代码
git checkout -b develop origin/develop

创建本地功能分支
git checkout -b feature-[name-desc] develop
1
2
3
4
5
6
7
  • 3.「开发者」在自己的分支上进行开发和代码提交，并推送到服务器分支
git add xxx

git commit -m 'commit comment'

git push
1
2
3
4
5
  • 4.「开发者」发起合并请求（merge request），「项目负责人」在收到请求后，对代码进行检查并合并。

# 日志规范

在一个团队协作的项目中，开发人员需要经常提交一些代码去修复bug或者实现新的feature。而项目中的文件和实现什么功能、解决什么问题都会渐渐淡忘，最后需要浪费时间去阅读代码。但是好的日志规范commit messages编写有帮助到我们，它也反映了一个开发人员是否是良好的协作者。

编写良好的Commit messages可以达到3个重要的目的:

  • 加快review的流程
  • 帮助我们编写良好的版本发布日志
  • 让之后的维护者了解代码里出现特定变化和feature被添加的原因

# Commit messages的基本语法

目前，社区有多种 Commit message 的写法规范。来自Angular 规范是目前使用最广的写法，比较合理和系统化。 Angular Git Commit Guidelines (opens new window)

具体格式为：

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
1
2
3
4
5

  • type: 本次 commit 的类型，诸如 bugfix docs style 等

  • scope: 本次 commit 波及的范围

  • subject: 简明扼要的阐述下本次 commit 的主旨，在原文中特意强调了几点

      1. 使用祈使句
      1. 首字母不要大写
      1. 结尾无需添加标点

  • body: 同样使用祈使句，在主体内容中我们需要把本次 commit 详细的描述一下，比如此次变更的动机，如需换行，则使用 |

  • footer: 描述下与之关联的 issue 或 break change

Type的类别说明：

  • feat: 添加新特性

  • fix: 修复bug

  • docs: 仅仅修改了文档

  • style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑

  • refactor: 代码重构，没有加新功能或者修复bug

  • perf: 增加代码进行性能测试

  • test: 增加测试用例

  • chore: 改变构建流程、或者增加依赖库、工具等

Commit messages格式要求

# 标题行：50个字符以内，描述主要变更内容
#
# 主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括:
#
# * 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等
# * 他如何解决这个问题? 具体描述解决问题的步骤
# * 是否存在副作用、风险?
1
2
3
4
5
6
7
Last Updated: 3/30/2021, 8:56:43 AM