Commit message 写法规范

一、概述对于日志的提交一直都没有形成一个很好的规范（每次提交都比较随意：<），最近看到一篇文章，里边有一章节介绍了一种写法规范（感觉还不错:>），从该文得知当前业界比较广泛应用的是 Angular Git Commit Guidelineshttps://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commi

cab5

846人浏览 · 2020-11-18 17:37:45

cab5 · 2020-11-18 17:37:45 发布

一、概述

对于日志的提交一直都没有形成一个很好的规范（每次提交都比较随意：<），最近看到一篇文章，里边有一章节介绍了一种写法规范（感觉还不错:>），从该文得知当前业界比较广泛应用的是 Angular Git Commit Guidelines

https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines

二、具体格式

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

type【必须】
本次 commit 的类型，类型如下：

类型	描述
feat	添加新特性
fix	修复bug
docs	仅仅修改了文档
style	仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
refactor	代码重构，没有加新功能或者修复bug
perf	增加代码进行性能测试
test	增加测试用例
chore	改变构建流程、或者增加依赖库、工具等

scope【可选】
scope 用于说明 commit 影响的范围，比如数据层（DAO）、控制层（CONTROLLER）、视图层（VIEW）等等，根据项目不同而不同。例如，在 Angular 可以是 $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView 等。如果你的修改影响了不止一个 scope，你可以使用 * 代替。
subject【必须】
简明扼要的阐述下本次 commit 的主旨，在原文中特意强调了几点:
- 使用祈使句，是不是很熟悉又陌生的一个词
- 首字母不要大写
- 结尾无需添加标点
body【必须】
同样使用祈使句，在主体内容中我们需要把本次 commit 详细的描述一下，比如此次变更的动机。
footer【可选】
描述下与之关联的 issue 或 break change。

二、格式要求

# 标题行：50个字符以内，描述主要变更内容
#
# 主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括:
#
# * 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等
# * 他如何解决这个问题? 具体描述解决问题的步骤
# * 是否存在副作用、风险?
#
# 如果需要的化可以添加一个链接到issue地址或者其它文档

如下图：
在这里插入图片描述
提交记录效果如下：