Commit message 的格式说明
赞
踩
如何让项目里面的Commit messages步入规范化，流程化。
每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。其中，Header 是必需的，Body 和 Footer 可以省略,不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。
Commit messages的基本语法
<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
- 1
- 2
- 3
- 4
- 5
Type表示提交类别，Subject表示标题行， Body表示主体描述内容。
Type的类别说明：
- feat: 添加新特性
- fix: 修复bug
- docs: 仅仅修改了文档
- style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
- refactor: 代码重构，没有加新功能或者修复bug
- perf: 增加代码进行性能测试
- test: 增加测试用例
- chore: 改变构建流程、或者增加依赖库、工具等
Commit messages格式要求
# 标题行：50个字符以内，描述主要变更内容
#
# 主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括:
#
# * 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等
# * 他如何解决这个问题? 具体描述解决问题的步骤
# * 是否存在副作用、风险?
#
# 如果需要的化可以添加一个链接到issue地址或者其它文档
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
Commit messages书写建议
Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）
a).type:用于说明 commit 的类别，只允许使用下面7个标识。如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。
- feat：新功能（feature）
- fix：修补bug
- fdocs：文档（documentation）
- style： 格式（不影响代码运行的变动）
- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
- test：增加测试
- chore：构建过程或辅助工具的变动
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
b).scope:用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
c).subject:是 commit 目的的简短描述，不超过50个字符。有两个注意点。(1).使用第一人称现在时，比如使用change而不是changed或changes。(2).应该说明代码变动的动机，以及与以前行为的对比。
*** 以动词开头，使用第一人称现在时，比如change，而不是changed或changes
*** 第一个字母小写
*** 结尾不加句号（.）
- 1
- 2
- 3
d).Body:分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。
More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Use a hanging indent
- 1
- 2
- 3
- 4
- 5
- 6
- 7
Footer:部分只用于两种情况。
a).不兼容变动(如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。)
BREAKING CHANGE: isolate scope bindings definition has changed. To migrate the code follow the example below: Before: scope: { myAttr: 'attribute', } After: scope: { myAttr: '@', } The removed `inject` wasn't generaly useful for directives so there should be no code using it.
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
b).关闭 Issue
(1).如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。
Closes #234
- 1
(2).也可以一次关闭多个 issue 。
Closes #123, #245, #992
- 1
Revert
还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。
revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
- 1
- 2
- 3
Body部分的格式是固定的，必须写成This reverts commit <hash>.，其中的hash是被撤销 commit 的 SHA 标识符。
如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的Reverts小标题下面。
欢迎进入个人公众号 ，一起学习啊！
参考链接：
Commit message 和 Change log 编写指南
Git Commit Message Conventions
Angular的 Commit Message Guidelines
Angular的commit message
Git 写出好的 commit message
