Git Message 编写指南

我们在日常使用Git提交代码时经常会写 commint message，否则就不允许提交。

一般来说，commit message 应该清晰明了，说明本次提交的目的。

目前，社区有多种 Commit message 的写法规范。本文介绍Angular规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。

格式化的Commit message 有什么好处？

• 提供更多的历史信息，方便快速浏览。

• 可以过滤某些commit（比如文档改动），便于快速查找信息。

• 可以直接从commit生成Change log。

Commit message 规范说明

如果使用 IDEA 开发，我们可以先装个插件： Git Commit Template

装完之后重启IDEA，如果我们提交代码会发现多了一个按钮：

image.png

点击之后就会出现一个 Commit Template，主要分为下面三个部分： Header， Body，Footer。

(): 
// 空一行

// 空一行

image.png

Header

Header的部分只有一行,包括三个字段: type(必需), scope(可选), subject(必需)

对应到idea插件上图的配置分别为 Header部分的:

• type(必需) Type of change commit类别
• scope(可选) Scope of this change commint影响的范围，如功能模块，或者版本号
• subject(必需) Short description 简短的描述，如果有Team任务，可以写提任务编号

type用于说明 commit 的类别，只允许使用下面7个标识

• feat：新功能（feature）
• fix：修补bug
• docs：文档（documentation）
• style： 格式（不影响代码运行的变动,空格,格式化,等等）
• refactor：重构（即不是新增功能，也不是修改bug的代码变动）
• perf: 性能 (提高代码性能的改变)
• test：增加测试或者修改测试
• build: 影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)
• ci: 对CI配置文件和脚本的更改
• chore：对非 src 和 test 目录的修改
• revert: Revert a commit

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

有两个注意点。

（1）使用第一人称现在时，比如使用change而不是changed或changes。

（2）应该说明代码变动的动机，以及与以前行为的对比。

Footer

Footer 部分只用于两种情况。

不兼容变动

如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。

关闭 Issue

如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。

实例

image.png