Git进阶篇（一）——Git注释规范

前言：
  为每一次的Git提交都打上Log是一个好习惯，在协作开发时统一一种注释风格，为提交写上简洁明了的注释是重要的，本篇文章介绍一种Git注释规范。

1 GCM（git commit message）格式

  使用Angular的GCM格式，将注释信息分为是三个部分，header、body、footer，它们各占一行。header必写但其scope是可选的，body和footer也是可选的。

1
2
3
4
5
<type>(<scope>): <subject>

<body>

<footer>

  每行不超过100字符。

1.1 header

  header占一行，包括三个字段type（必须）、scope（可选）、subject（必选）。

1.1.1 Type

  type的规则为下列之一：

  • feature：新功能；
  • fix：修补bug；
  • docs：文档修改；
  • style：不影响代码含义的修改，比如规范化修改；
  • refactor：重构；
  • perf：提升性能的修改；
  • test：增加或修改测试；
  • chore：构建流程或辅助工具的变动；

1.1.2 Scope

  scope说明本次提交修改的范围，层级、模块等，如果同时修改多处可使用“*”。

1.1.3 subject

  是对修改的简要说明：

  • 使用祈使句，一般现在时；
  • 首字母小写；
  • 句末不使用句号；

1.2 Body

  使用祈使句，一般现在时。body中需要写明变更原因和变更点。

  Breaking change（破坏性变化/重大变化）或关闭issue的信息都写在footer。