Ashin Wang's Blog

Git Commit Message Conventions

发表于 分类于

Git Commit Message Conventions Angular 规范

转载：

1
2
3
4
5
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Type

type 用于说明 commit 的类别，必须为以下类型的一种：

  • feat: 新的功能
  • fix: 修复 bug
  • docs: 只是文档的更改
  • style: 不影响代码含义的更改 (例如空格、格式化、少了分号)
  • refactor: 既不是修复 bug 也不是添加新功能的代码更改
  • perf: 提高性能的代码更改
  • test: 添加或修正测试
  • chore: 对构建或者辅助工具的更改，例如生成文档

Scope

scope 用于说明 commit 影响的范围，当影响的范围有多个时候，可以使用 *。

Subject

subject 用于对 commit 变化的简洁描述：

  • 使用祈使句，一般以动词原形开始，例如使用 change 而不是 changed 或者 changes
  • 第一个字母小写
  • 结尾不加句号（.）

Body

body 用于对 commit 详细描述。使用祈使句，一般以动词原形开始，例如使用 change 而不是 changed 或者 changes。

body 应该包含这次变化的动机以及与之前行为的对比。

footer 目前用于两种情况。

推荐阅读