Git提交规范化

目的

  • 统一团队Git Commit标准,便于后续代码review、版本发布、自动化生成change log
  • 可以提供更多更有效的历史信息,方便快速预览以及配合cherry-pick快速合并代码;
  • 团队其他成员进行类git blame时可以快速明白代码用意;

Git版本规范

分支

master分支为主分支(保护分支),不能直接在master上进行修改代码和提交;
develop分支为测试分支,所以开发完成需要提交测试的功能合并到该分支;
feature分支为开发分支,大家根据不同需求创建独立的功能分支,开发完成后合并到develop分支;
fix分支为bug修复分支,需要根据实际情况对已发布的版本进行漏洞修复;

Tag

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

架构升级或架构重大调整,修改第2位
新功能上线或者模块大的调整,修改第2位
bug修复上线,修改第3位

changelog

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

image.png

Git提交信息

message信息格式采用目前主流的Angular规范,这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。

commit message格式说明

Commit message一般包括三部分:HeaderBodyFooter

Header

type(scope):subject

  • type:用于说明commit的类别,规定为如下几种
    • feat:新增功能;
    • fix:修复bug
    • docs:修改文档;
    • refactor:代码重构,未新增任何功能和修复任何bug
    • build:改变构建流程,新增依赖库、工具等(例如webpack修改);
    • style:仅仅修改了空格、缩进等,不改变代码逻辑;
    • perf:改善性能和体现的修改;
    • chore:非srctest的修改;
    • test:测试用例的修改;
    • ci:自动化流程配置修改;
    • revert:回滚到上一个版本;
  • scope:【可选】用于说明commit的影响范围
  • subjectcommit的简要说明,尽量简短

Body

对本次commit的详细描述,可分多行

Footer

不兼容变动:需要描述相关信息
关闭指定Issue:输入Issue信息


如有误点,多多指教 喜欢呦~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Git 规范 所有使用了本规范的项目,必须严格规范操作,否则不予以合并代码、提测、打包上线等后续操作。 基本要求 ...
    zgsddzwj阅读 13,827评论 1 14
  • Git常用语法 [TOC] Git简介 描述 ​ Git(读音为/gɪt/。)是一个开源的分布式版本控制系统,...
    君惜丶阅读 3,638评论 0 13
  • 多种多样的工作流使得在项目中实施Git时变得难以选择。这份教程提供了一个出发点,调查企业团队最常见的Git工作流。...
    JSErik阅读 4,491评论 2 8
  • 都说这个很难做到,你瞅瞅!都说这个很难做到,你瞅瞅!都说这个很难做到,你瞅瞅!都说这个很难做到,你瞅瞅!都说这个很...
    张三爷123阅读 260评论 0 0
  • 年少轻狂 年少莽撞 年少无畏 无迷惘 朝如烈阳 暮如海浪 心怀执念 盼远方 妄欲如风 贪欲如霜 善恶因果 被遗忘 ...
    洛瑾阑阅读 384评论 0 1