Git: 语义化Commit Message

Table of contents

场景

在很多开源的项目中,都使用了语义化格式的git commit,用来表达本次提交主要内容,旨在提高 Review Code 效率和统一协作方式。

简介

格式:<type>(<scope>): <subject>

<scope>是可选的

例子

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

更多示例:

  1. feat:(用户的新功能,而不是构建脚本的新功能)

  2. fix: (针对用户的错误修复,而不是对构建脚本的修复)

  3. docs:(对文档的更改)

  4. style:(格式化,缺少分号等;没有生产代码更改)

  5. refactor:(重构生产代码,例如重命名变量)

  6. test:(添加缺失的测试,重构测试;没有生产代码更改)

  7. chore:(更新配置之类,如 grunt 任务等;没有生产代码更改)

参考