git 提交规范

提交格式

简易格式

如改动内容较少,可采用此格式,简单说明修改类型、涉及文件(可省略)和修改内容

git commit -m [message]

message内容如下

type(<scope>): subject

标准格式

如改动内容较多,采用此格式,详细说明各项内容

git commit 

编辑内容如下

type(<scope>): subject

<Body>

<Footer>

type

用于说明 commit 的提交类型(必须是以下几种之一)。

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式 不影响代码含义的改动,例如去掉空格、改变缩进、增删分号
  • build:构造工具的或者外部依赖的改动,例如webpack,npm
  • refactor:代码重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

scope

  • scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视仓库不同而不同。不能判断是否有影响时,用 * 代替,如(*)

subject

  • subject是 commit目的的简短描述,不超过50个字符。

Body

  • Body 部分是对本次 commit 的详细描述。
  • 应该说明代码变动的动机,以及与以前行为的对比。
  • 如果本次提交的代码是突破性的变更或关闭缺陷,则 Footer 必需,否则可以省略。

突破性的变更

  • 当前代码与上一个版本有突破性改变,则 Footer 以 BREAKING CHANGE 开头,后面是对变动的描述、以及变动的理由。

关闭缺陷

  • 如果当前提交是针对特定的 issue,那么可以在 Footer 部分填写需要关闭的单个 issue 或一系列 issues。
Last Updated:
Contributors: wangyifan