git commit message 的提交规范

2016-07-04

字数统计: 388字 | 阅读时长≈ 1分

格式

提交信息包括三个部分：Header，Body 和 Footer。

<Header>
<!-- 空行 -->
<Body>
<!-- 空行 -->
<Footer>

其中，Header 是必需的，Body 和 Footer 可以省略。

Header部分只有一行，包括俩个字段：type（必需）和subject（必需）。

<type>: <subject>

type

type用于说明 commit 的类别，可以使用如下类别：

feat：新功能（feature）
fix：修补bug
doc：文档（documentation）
style：格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动

subject

subject是 commit 目的的简短描述。

以动词开头，使用第一人称现在时，比如change，而不是changed或changes
第一个字母小写
结尾不加句号（。）

Body

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

注意：应该说明代码变动的动机，以及与以前行为的对比。

Footer 部分只用于两种情况：

关联 Issue
关闭 Issue

下面是一个范例。

Issue #1, #2, #3
Close #1, #2, #3

例子

下面是一个完整的例子。

feat: 完成文章分享功能

给每篇博文添加了分享功能

- 添加分享到微博功能
- 添加分享到微信功能
- 添加分享到朋友圈功能

Issue #1, #2
Close #1

参考链接

Commit message 和 Change log 编写指南

本文作者： kriss
本文链接： http://www.kriss.pub/2016/07/04/git-commit-message/
版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！