约定式提交

一种用以给提交信息增加人机可读的信息的规范

约定式提交 1.0.0-beta.2

概述

开源维护者在将特性分支合并入 master 时,可编写标准化的提交说明。

提交说明的结构如下所示:


<类型>[可选的作用域]: <描述>

[可选的正文]

[可选的脚注]


提交说明包含了下面的结构化元素,以向类库使用者表明其意图:

  1. fix: 类型fix 的提交表示在代码库中修复了一个 bug(这和语义化版本中的 PATCH 相对应)。
  2. feat: 类型feat 的提交表示在代码库中新增了一个功能(这和语义化版本中的 MINOR 相对应)。
  3. BREAKING CHANGE: 在可选的正文或脚注的起始位置带有 BREAKING CHANGE: 的提交,表示引入了破坏性 API 变更(这和语义化版本中的 MAJOR 相对应)。破坏性变更可以是任意 类型 提交的一部分。例如 fix:feat:chore:,乃至对于更多其它的 类型 而言,它都是有效的。
  4. 其它情况:fix:feat: 之外的提交 类型 也是被允许的,例如 @commitlint/config-conventional(基于 Angular 约定)中推荐的 chore:docs:style:refactor:perf:test: 及其他标签。我们也推荐使用improvement,用于对当前实现进行改进而没有添加新功能或修复错误的提交。请注意,这些标签在约定式提交规范中并不是强制性的,并且在语义化版本中没有隐式的影响(除非它们包含这种情况下本不被推荐的 BREAKING CHANGE)。
    可以为提交类型添加一个围在圆括号内的作用域,以为其提供额外的上下文信息。例如 feat(parser): adds ability to parse arrays

示例

包含了描述以及正文内有破坏性变更的提交说明

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

不包含正文的提交说明

docs: correct spelling of CHANGELOG

包含作用域的提交说明

feat(lang): added polish language

为 fix 编写的提交说明,包含(可选的) issue 编号

fix: minor typos in code

see the issue for details on the typos fixed

fixes issue #12

介绍

在软件开发中,以我个人的经验来说,bug 最常产生在应用间的边界情况中。单元测试在开源维护者已知的交互场景下工作得很好。但对于社区中各种有趣且常常是意想不到的方式使用类库的情况,它就覆盖得比较差了。

那些经历过在升级了一个依赖新的 patch 版本后,发现自己的应用竟开始抛出稳定的 500 错误流的人,都明白一个可读的提交历史(以及理想的维护良好的 CHANGELOG)对于排错有多重要。

约定式的提交规范提议在提交说明的基础上,引入一种标准化的轻量级约定。这个约定和 SemVer 相吻合,它要求开发者在提交信息中描述他们所改动的新特性、bug 修复和破坏性变更。

引入这一约定后,我们可以创建一种通用的语言,更易于在项目边界间调试问题。

约定式提交规范

本文中的关键词 “必须(MUST)”、“禁止(MUST NOT)”、“需要(REQUIRED)”、“应当(SHALL)”、“不应当(SHALL NOT)”、“应该(SHOULD)”、“不应该(SHOULD NOT)”、“推荐(RECOMMENDED)”、“可以(MAY)” 和 “可选(OPTIONAL)” ,解释参考 RFC 2119 中所述。

  1. 每个提交都必须使用类型字段前缀,它由一个名词组成,诸如 featfix ,其后接冒号(英文半角)和空格。
  2. 当一个提交为应用或类库实现了新特性时,必须使用 feat 类型。
  3. 当一个提交为应用修复了 bug 时,必须使用 fix 类型。
  4. 可选的作用域字段可以在类型后提供。作用域是描述代码库中某个部分的词组,封装在圆括号中,例如: fix(parser):
  5. 描述字段必须紧接在类型或作用域前缀之后。描述指的是对代码变更的简短描述,例如: fix: array parsing issue when multiple spaces were contained in string.
  6. 在简短描述之后,可以编写更长的提交正文,为代码变更提供额外的上下文信息。正文必须起始于描述字段结束的一个空行后。
  7. 在正文结束的一个空行后,可以编写脚注(如果没有正文,可以编写在描述之后)。脚注应当为代码变更包含额外的 issue 引用信息(比如它所修复的 issue,例如: Fixes #13)。
  8. 破坏性变更必须在提交的正文或脚注加以展示。一个破坏性变更必须包含大写的文本 BREAKING CHANGE,紧跟冒号和空格。
  9. BREAKING CHANGE: 之后必须提供描述,以描述对 API 的变更。例如: BREAKING CHANGE: environment variables now take precedence over config files.
  10. 脚注必须只包含 BREAKING CHANGE、外部链接、issue 引用和其它元信息。
  11. 在提交说明中,可以使用 featfix 之外的类型。

为什么使用约定式提交

FAQ

在初始开发阶段我该如何处理提交说明?

我们建议你按照假设你已发布了产品那样来处理。因为通常总 有人 使用你的软件,即便那是你软件开发的同事们。他们会希望知道诸如修复了什么、哪里不兼容等信息。

如果提交符合多种类型我该如何操作?

回退并尽可能创建多次提交。约定式提交的好处之一是能够促使我们做出更有组织的提交和 PR。

这不会阻碍快速开发和迭代吗?

它阻碍的是以杂乱无章的方式快速前进。它助你能在横跨多个项目以及和多个贡献者协作时长期地快速演进。

约定式提交会让开发者受限于提交的类型吗(因为他们会想着已提供的类型)?

约定式提交鼓励我们更多地使用某些类型的提交,比如 fixes。除此之外,约定式提交的灵活性也允许你的团队使用自己的类型,并随着时间的推移更改这些类型。

这和 SemVer 有什么关联呢?

fix 类型提交应当对应到 PATCH 版本。feat 类型提交应该对应到 MINOR 版本。带有 BREAKING CHANGE 的提交不管类型如何,都应该对应到 MAJOR 版本。

我对约定式提交做了形如 @jameswomack/conventional-commit-spec 的扩展,该如何版本化管理这些扩展呢?

我们推荐使用 SemVer 来发布你对于这个规范的扩展(并鼓励你创建这些扩展!)

如果我不小心使用了错误的提交类型,该怎么办呢?

当你使用了在规范中但错误的类型时,例如将 feat 写成了 fix

在合并或发布这个错误之前,我们建议使用 git rebase -i 来编辑提交历史。而在发布之后,根据你使用的工具和流程不同,会有不同的清理方案。

当使用了*不*在规范中的类型时,例如将 feat 写成了 feet

在最坏的场景下,即便提交没有满足约定式提交的规范,也不会是世界末日。这只意味着这个提交会被基于规范的工具错过而已。

所有的贡献者都需要使用约定式提交规范吗?

并不!如果你使用基于 squash 的 Git 工作流,主管维护者可以在合并时清理提交信息——这不会对普通提交者产生额外的负担。有种常见的工作流是让 git 系统自动从 pull request 中 squash 出提交,并向主管维护者提供一份表单,用以在合并时输入合适的 git 提交信息。

关于

约定式提交规范受到了 Angular 提交准则的启发,并在很大程度上以其为依据。

该规范的首个草案来自下面这些项目中若干贡献者们的协作:

使用约定式提交的项目

Conventional Commits

想让你的项目出现在上面吗? 提交 pull request 吧。