一、为什么需要规范

无规矩不成方圆，编程也一样。Git Commit 规范可能并没有那么夸张，但如果你在版本回退的时候看到一大段糟心的 Commit，恐怕会懊恼不已吧。 所以，严格遵守规范，利人利己。

规范 commit message 的好处

  • 首行就是简洁实用的关键信息，方便在 git history 中快速浏览
  • 具有详实的 body 和 footer ，可以清晰的看出某次提交的目的和影响
  • 可以通过 type 过滤出想要查找的信息，也可以通过关键字快速查找相关提交
  • 可以直接从 commit 生成 change log

二、具体规则

分支：

  • 1.master：主分支（保护分支），不能直接在master上进行修改代码和提交；

  • 2.develop:测试分支，所有开发完成需求提交测试的功能合并到该分支；

  • 3.feature(feature-*):新功能开发分支，根据不同需求创建独立的功能分支，开发完成后合并到develop分支；

  • 4.hotfix(hotfix-*):bug修复分支，根据实际情况对已发布的版本进行漏洞修复；

  • 5.release:预发布分支；

  • 主分支名称：master

  • 主开发分支名称：develop

  • 新功能开发分支名称：feature-or feature/，其中“*” 为新功能简述，如：feature-item-activity-list

  • 发布分支名称：release-or release/，其中*为版本号，“release”小写，如：release-1.0.0

  • master的bug修复分支名称：hotfix-or hotfix/，其中*为bug简述，如：hotfix/item-update-bug

Tag(标签)

采用三段式，v版本.里程碑.序号，如v1.2.3

  1. 架构升级或架构重大调整，修改第1位
  2. 新功能上线或者模块大的调整，修改第2位
  3. bug修复上线，修改第3位
  4. 名称：v*.RELEASE，其中”*“ 为版本号，“RELEASE”大写，如：v1.0.0.RELEASE

ChangeLog

  • 版本正式发布后，需要生产changelog文档，便于后续问题追溯。

Git commit日志基本规范