mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2024-11-15 02:45:15 +01:00
659483a245
Keeping up with new version of Conventional Commits. Refine some translation, especially the Summary, it's so important that MUST use clear and precise expression. Some terms see footers. Conventional-Commit: 约定式提交 footer[s]: 脚注 scope: 范围, 不应该使用作用域, 面向人读的文档应该使用普通词汇. token: 令牌 Specification: 规范
257 lines
16 KiB
Markdown
257 lines
16 KiB
Markdown
---
|
||
draft: false
|
||
aliases: ["/zh/", "/zh-hans/"]
|
||
---
|
||
|
||
# 约定式提交 1.0.0
|
||
|
||
## 概述
|
||
|
||
约定式提交规范是一种基于提交信息的轻量级约定。
|
||
它提供了一组简单规则来创建清晰的提交历史；
|
||
这更有利于编写自动化工具。
|
||
通过在提交信息中描述功能、修复和破坏性变更，
|
||
使这种惯例与 [SemVer](http://semver.org) 相互对应。
|
||
|
||
提交说明的结构如下所示：
|
||
|
||
---
|
||
|
||
原文：
|
||
|
||
```
|
||
<type>[optional scope]: <description>
|
||
|
||
[optional body]
|
||
|
||
[optional footer(s)]
|
||
```
|
||
|
||
译文：
|
||
|
||
```
|
||
<类型>[可选 范围]: <描述>
|
||
|
||
[可选 正文]
|
||
|
||
[可选 脚注]
|
||
```
|
||
---
|
||
|
||
<br />
|
||
提交说明包含了下面的结构化元素，以向类库使用者表明其意图：
|
||
|
||
1. **fix:** _类型_ 为 `fix` 的提交表示在代码库中修复了一个 bug（这和语义化版本中的 [`PATCH`](https://semver.org/lang/zh-CN/#%E6%91%98%E8%A6%81) 相对应）。
|
||
2. **feat:** _类型_ 为 `feat` 的提交表示在代码库中新增了一个功能（这和语义化版本中的 [`MINOR`](https://semver.org/lang/zh-CN/#%E6%91%98%E8%A6%81) 相对应）。
|
||
3. **BREAKING CHANGE:** 在脚注中包含 `BREAKING CHANGE:` 或 <类型>(范围) 后面有一个 `!` 的提交，表示引入了破坏性 API 变更（这和语义化版本中的 [`MAJOR`](https://semver.org/lang/zh-CN/#%E6%91%98%E8%A6%81) 相对应）。
|
||
破坏性变更可以是任意 _类型_ 提交的一部分。
|
||
1. 除 `fix:` 和 `feat:` 之外，也可以使用其它提交 _类型_ ，例如 [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)（基于 [Angular 约定](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)）中推荐的 `build:`、`chore:`、
|
||
`ci:`、`docs:`、`style:`、`refactor:`、`perf:`、`test:`，等等。
|
||
1. 脚注中除了 `BREAKING CHANGE: <description>` ，其它条目应该采用类似
|
||
[git trailer format](https://git-scm.com/docs/git-interpret-trailers) 这样的惯例。
|
||
|
||
其它提交类型在约定式提交规范中并没有强制限制，并且在语义化版本中没有隐式影响（除非它们包含 BREAKING CHANGE）。
|
||
<br /><br />
|
||
可以为提交类型添加一个围在圆括号内的范围，以为其提供额外的上下文信息。例如 `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
|
||
```
|
||
|
||
### 包含了 `!` 字符以提醒注意破坏性变更的提交说明
|
||
```
|
||
refactor!: drop support for Node 6
|
||
```
|
||
|
||
### 包含了 `!` 和 BREAKING CHANGE 脚注的提交说明
|
||
```
|
||
refactor!: drop support for Node 6
|
||
|
||
BREAKING CHANGE: refactor to use JavaScript features not available in Node 6.
|
||
```
|
||
|
||
### 不包含正文的提交说明
|
||
```
|
||
docs: correct spelling of CHANGELOG
|
||
```
|
||
|
||
### 包含范围的提交说明
|
||
```
|
||
feat(lang): add polish language
|
||
```
|
||
|
||
### 包含多行正文和多行脚注的提交说明
|
||
```
|
||
fix: correct minor typos in code
|
||
|
||
see the issue for details
|
||
|
||
on typos fixed.
|
||
|
||
Reviewed-by: Z
|
||
Refs #133
|
||
```
|
||
|
||
## 约定式提交规范
|
||
|
||
本文中的关键词 “必须（MUST）”、“禁止（MUST NOT）”、“必要（REQUIRED）”、“应当（SHALL）”、“不应当（SHALL NOT）”、“应该（SHOULD）”、“不应该（SHOULD NOT）”、“推荐（RECOMMENDED）”、“可以（MAY）” 和 “可选（OPTIONAL）” ，其相关解释参考 [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) 。
|
||
|
||
1. 每个提交都**必须**使用类型字段前缀，它由一个名词构成，诸如 `feat` 或 `fix` ，
|
||
其后接**可选的**范围字段，**可选的** `!`，以及**必要的**冒号（英文半角）和空格。
|
||
1. 当一个提交为应用或类库实现了新功能时，**必须**使用 `feat` 类型。
|
||
1. 当一个提交为应用修复了 bug 时，**必须**使用 `fix` 类型。
|
||
1. 范围字段**可以**跟随在类型字段后面。范围**必须**是一个描述某部分代码的名词，并用圆括号包围，例如： `fix(parser):`
|
||
1. 描述字段**必须**直接跟在 <类型>(范围) 前缀的冒号和空格之后。
|
||
描述指的是对代码变更的简短总结，例如： _fix: array parsing issue when multiple spaces were contained in string_ 。
|
||
1. 在简短描述之后，**可以**编写较长的提交正文，为代码变更提供额外的上下文信息。正文**必须**起始于描述字段结束的一个空行后。
|
||
1. 提交的正文内容自由编写，并**可以**使用空行分隔不同段落。
|
||
1. 在正文结束的一个空行之后，**可以**编写一行或多行脚注。每行脚注都**必须**包含
|
||
一个令牌（token），后面紧跟 `:<space>` 或 `<space>#` 作为分隔符，后面再紧跟令牌的值（受
|
||
[git trailer convention](https://git-scm.com/docs/git-interpret-trailers) 启发）。
|
||
1. 脚注的令牌**必须**使用 `-` 作为连字符，比如 `Acked-by` (这样有助于
|
||
区分脚注和多行正文)。有一种例外情况就是 `BREAKING CHANGE`，它**可以**被认为是一个令牌。
|
||
1. 脚注的值**可以**包含空格和换行，值的解析过程**必须**直到下一个脚注的令牌/分隔符出现为止。
|
||
1. 破坏性变更**必须**在提交信息中标记出来，要么在 <类型>(范围) 前缀中标记，要么作为脚注的一项。
|
||
1. 包含在脚注中时，破坏性变更**必须**包含大写的文本 `BREAKING CHANGE`，后面紧跟着冒号、空格，然后是描述，例如：
|
||
_BREAKING CHANGE: environment variables now take precedence over config files_ 。
|
||
1. 包含在 <类型>(范围) 前缀时，破坏性变更**必须**通过把 `!` 直接放在 `:` 前面标记出来。
|
||
如果使用了 `!`，那么脚注中**可以**不写 `BREAKING CHANGE:`，
|
||
同时提交信息的描述中**应该**用来描述破坏性变更。
|
||
1. 在提交说明中，**可以**使用 `feat` 和 `fix` 之外的类型，比如：_docs: updated ref docs._ 。
|
||
1. 工具的实现必须**不区分**大小写地解析构成约定式提交的信息单元，只有 `BREAKING CHANGE` **必须**是大写的。
|
||
1. BREAKING-CHANGE 作为脚注的令牌时**必须**是 BREAKING CHANGE 的同义词。
|
||
|
||
## 为什么使用约定式提交
|
||
|
||
* 自动化生成 CHANGELOG。
|
||
* 基于提交的类型，自动决定语义化的版本变更。
|
||
* 向同事、公众与其他利益关系者传达变化的性质。
|
||
* 触发构建和部署流程。
|
||
* 让人们探索一个更加结构化的提交历史，以便降低对你的项目做出贡献的难度。
|
||
|
||
## 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 提交信息。
|
||
|
||
### 约定式提交规范中如何处理还原（revert）提交?
|
||
|
||
还原提交（Reverting）会比较复杂：你还原的是多个提交吗？如果你还原了一个功能模块，下次发布的应该是补丁吗？
|
||
|
||
约定式提交不能明确的定义还原行为。所以我们把这个问题留给工具开发者，
|
||
基于 _类型_ 和 _脚注_ 的灵活性来开发他们自己的还原处理逻辑。
|
||
|
||
一种建议是使用 `revert` 类型，和一个指向被还原提交摘要的脚注：
|
||
|
||
```
|
||
revert: let us never again speak of the noodle incident
|
||
|
||
Refs: 676104e, a215868
|
||
```
|
||
|
||
## 关于
|
||
|
||
约定式提交规范受到了 [Angular 提交准则](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit)的启发，并在很大程度上以其为依据。
|
||
|
||
该规范的首个草案来自下面这些项目中若干贡献者们的协作：
|
||
|
||
* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)：一套从 git 历史中解析出约定式提交说明的工具。
|
||
* [parse-commit-message](https://npmjs.com/package/parse-commit-message)：用于转换、字符串化、校验约定式提交信息的扩展工具。
|
||
* [bumped](https://bumped.github.io)：一个用于发布软件的工具，可以在为你的软件发布新版本前后轻松地执行操作。
|
||
* [unleash](https://github.com/netflix/unleash)：一个用于自动化软件发行和发布生命周期的工具。
|
||
* [lerna](https://github.com/lerna/lerna)：一个用于管理宏仓库（monorepo）的工具，源自 Babel 项目。
|
||
|
||
## 用于约定式提交的工具
|
||
|
||
* [fastlane-plugin](https://github.com/xotahal/fastlane-plugin-semantic_release): 根据规范管理版本并自动生成变更日志。
|
||
* [commitizen/cz-cli](https://github.com/commitizen/cz-cli): Node.js 工具，用于创建遵循约定式提交规范的提交信息。
|
||
* [commitizen-tools/commitizen](https://github.com/commitizen-tools/commitizen): Python 编写的项目提交规则创建工具，自动增加版本号并生成变更记录。
|
||
* [php-commitizen](https://github.com/damianopetrungaro/php-commitizen): PHP工具，用于创建遵循约定式提交规范的提交信息。
|
||
可配置，并且可以作为 composer 依赖项用于 PHP 项目，或可在非 PHP 项目中全局使用。
|
||
* [commitlint](https://github.com/conventional-changelog/commitlint): 用于检查提交信息是否符合约定式提交规范的检查器。
|
||
* [gitlint](https://github.com/jorisroovers/gitlint): Python 开发的 Git 提交信息检查器，可以通过 [enforce Conventional Commits format](https://jorisroovers.com/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits) 进行配置。
|
||
* [conform](https://github.com/autonomy/conform): 一个可用以在 git 仓库上施加配置的工具，包括约定式提交。
|
||
* [detect-next-version](https://npmjs.com/package/detect-next-version): 对约定式提交规范的内容进行解析、检测并提取出元信息。
|
||
* [recommended-bump](https://www.npmjs.com/package/recommended-bump): 根据约定式提交的信息计算并推荐新版本号。
|
||
* [git-commits-since](https://www.npmjs.com/package/git-commits-since): 获取一个周期内或上一个语义化版本到现在的所有原始提交信息，支持自定义插件。
|
||
* [standard-version](https://github.com/conventional-changelog/standard-version): 自动化的版本和 CHANGELOG 管理。使用 GitHub 新的合并提交按钮，并推荐使用约定式提交工作流。
|
||
* [Conventional Commit](https://github.com/lppedd/idea-conventional-commit): 在版本控制系统的提交窗口中提供可扩展的约定式提交规范模板，可以用于所有 [JetBrains IDEs](https://www.jetbrains.com/)。
|
||
* [Git Commit Template](https://plugins.jetbrains.com/plugin/9861-git-commit-template): 在 [JetBrains Editors](https://www.jetbrains.com/) (IntelliJ IDEA, PyCharm, PhpStorm...) 中增加约定式提交规范的支持。
|
||
* [commitsar](https://github.com/commitsar-app/commitsar): Go 工具，用于检查分支上的提交信息是否符合约定式提交规范，并提供了 Docker 镜像给 CI 用户使用。
|
||
* [semantic-release](https://github.com/semantic-release/semantic-release): 一个自动化整个项目的工具，包括：决定下一个版本号，生成发布说明并发布项目包。
|
||
* [python-semantic-release](https://github.com/relekang/python-semantic-release): 为 Python 项目提供自动化语义版本。这是一个 Python 版本的 [semantic-release](https://github.com/semantic-release/semantic-release)。
|
||
* [VSCode Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits): 为 VSCode 添加约定式提交规范的支持。
|
||
* [Pyhist](https://github.com/jgoodman8/pyhist): Python 工具，根据 git 历史记录自动更新包版本并生成变更日志。
|
||
* [git-mkver](https://github.com/idc101/git-mkver): 根据 _Conventional Commits_ 在 git 项目中自动实现语义化版本的工具。
|
||
* [Conventional Commits Next Version](https://gitlab.com/DeveloperC/conventional_commits_next_version): 跨语言工具，从最近的一个版本开始，根据符合 _Conventional Commits_ 的提交信息，计算下一个语义化版本。
|
||
|
||
## 使用约定式提交的项目
|
||
|
||
* [yargs](https://github.com/yargs/yargs)：广受欢迎的命令行参数解析器。
|
||
* [istanbuljs](https://github.com/istanbuljs/istanbuljs)：一套为 JavaScript 测试生成测试覆盖率的开源工具和类库。
|
||
* [uPortal-home](https://github.com/UW-Madison-DoIT/angularjs-portal) 和 [uPortal-application-framework](https://github.com/UW-Madison-DoIT/uw-frame)：用于增强 [Apereo uPortal](https://www.apereo.org/projects/uportal) 的可选用户界面。
|
||
* [massive.js](https://github.com/dmfay/massive-js)：一个用于 Node 和 PostgreSQL 的数据访问类库。
|
||
* [electron](https://github.com/electron/electron)：用 JavaScript、HTML 和 CSS 构建跨平台应用。
|
||
* [scroll-utility](https://github.com/LeDDGroup/scroll-utility)：一个居中元素和平滑动画的滚屏工具包实例。
|
||
* [Blaze UI](https://github.com/BlazeUI/blaze)：无框架开源 UI 套件。
|
||
* [Monica](https://github.com/monicahq/monica)：一个开源的人际关系管理系统。
|
||
* [mhy](https://mhy.js.org)：一个零配置、开箱即用的、多用途工具箱与开发环境。
|
||
* [@tandil/diffparse](https://github.com/danielduarte/diffparse#readme): 简单的 Diff 文件解析器（统一 diff 格式）。
|
||
* [@tandil/diffsplit](https://github.com/danielduarte/diffsplit#readme): 快速将 .diff 和 .patch 拆分成独立文件。
|
||
* [@thi.ng/umbrella](https://github.com/thi-ng/umbrella): 数据驱动开发的 ~100 个 TypeScript 项目。
|
||
* [yii2-basic-firestarter](https://github.com/HunWalk/yii2-basic-firestarter): 🔥 Yii2应用的增强模板。
|
||
* [dcyou/resume](https://github.com/dcyou/resume): 😎 快速创建在线简历的模板。
|
||
* [Nintex Forms](https://www.nintex.com/workflow-automation/modern-forms/): 方便的创建动态在线表单并获准确、实时数据。
|
||
* [Tina CMS](https://tinacms.org): 为你的网站创建前端内容管理的开源工具集。
|
||
* [Uno Platform](https://platform.uno): 使用 C# 和 XAML 创建移动、桌面和 WebAssembly 应用。今天，开源并给予专业支持。
|
||
|
||
|
||
[](https://conventionalcommits.org)
|
||
|
||
_想让你的项目出现在上面吗？_ [提交 pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls) 吧。
|