diff --git a/config.yaml b/config.yaml index 5f98722..ea039cc 100755 --- a/config.yaml +++ b/config.yaml @@ -72,17 +72,18 @@ languages: - v1.0.0-beta zh: weight: 2 - languageName: "Chinese" + languageName: "简体中文" title: 约定式提交 - description: 一种规范，用于添加人机可读的含义以提交消息 + description: 一种规范，用以给提交信息增加人机可读的信息 actions: - label: 阅读规范 url: '#约定式提交规范' - label: GitHub url: 'https://github.com/conventional-commits/conventionalcommits.org' versions: - current: v1.0.0-beta.2 + current: v1.0.0-beta.3 list: + - v1.0.0-beta.3 - v1.0.0-beta.2 - v1.0.0-beta.1 - v1.0.0-beta diff --git a/content/v1.0.0-beta.2/index.zh.md b/content/v1.0.0-beta.2/index.zh.md index 7b3c93b..b4c2dcf 100644 --- a/content/v1.0.0-beta.2/index.zh.md +++ b/content/v1.0.0-beta.2/index.zh.md @@ -25,17 +25,16 @@ aliases: ["/zh/"]
提交说明包含了下面的结构化元素，以向类库使用者表明其意图： -1. **fix:** _类型_ 为 `fix` 的提交表示在代码库中修复了一个 bug（这和语义化版本中的 [`PATCH`](http://semver.org/#summary) 相对应）。 -1. **feat:** _类型_ 为 `feat` 的提交表示在代码库中新增了一个功能（这和语义化版本中的 [`MINOR`](http://semver.org/#summary) 相对应）。 -1. **BREAKING CHANGE:** 在可选的正文或脚注的起始位置带有 `BREAKING CHANGE:` 的提交，表示引入了破坏性变更（这和语义化版本中的 [`MAJOR`](http://semver.org/#summary) 相对应）。破坏性变更可以是任意 _类型_ 提交的一部分。对于 `fix:`、`feat:` 和 `chore:`，乃至更多其它的 _类型_ 而言，它都是有效的。 -1. 其它在 `fix:` 和 `feat:` 之外的提交 _类型_ 也都是支持的，例如 [Angular 约定](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) 中推荐使用 `docs:`、`style:`、`refactor:`、`perf:`、`test:`、`chore:`，但这些标签在约定式提交规范中并不是强制性的。 - +1. **fix:** _类型_ 为 `fix` 的提交表示在代码库中修复了一个 bug（这和语义化版本中的 [`PATCH`](https://semver.org/lang/zh-CN/#%E6%91%98%E8%A6%81) 相对应）。 +1. **feat:** _类型_ 为 `feat` 的提交表示在代码库中新增了一个功能（这和语义化版本中的 [`MINOR`](https://semver.org/lang/zh-CN/#%E6%91%98%E8%A6%81) 相对应）。 +1. **BREAKING CHANGE:** 在可选的正文或脚注的起始位置带有 `BREAKING CHANGE:` 的提交，表示引入了破坏性 API 变更（这和语义化版本中的 [`MAJOR`](https://semver.org/lang/zh-CN/#%E6%91%98%E8%A6%81) 相对应）。破坏性变更可以是任意 _类型_ 提交的一部分。例如 `fix:`、`feat:` 和 `chore:`，乃至对于更多其它的 _类型_ 而言，它都是有效的。 +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)）中推荐的 `chore:`、`docs:`、`style:`、`refactor:`、`perf:`、`test:` 及其他标签。我们也推荐使用`improvement`，用于对当前实现进行改进而没有添加新功能或修复错误的提交。请注意，这些标签在约定式提交规范中并不是强制性的，并且在语义化版本中没有隐式的影响（除非它们包含这种情况下本不被推荐的 BREAKING CHANGE）。
-可以为提交类型添加一个围在圆括号内的作用域，以为其提供额外的上下文信息。例如 `feat(parser): adds ability to parse arrays.` +可以为提交类型添加一个围在圆括号内的作用域，以为其提供额外的上下文信息。例如 `feat(parser): adds ability to parse arrays`。 ## 示例 -### 包含了描述和正文内破坏性变更的提交说明 +### 包含了描述以及正文内有破坏性变更的提交说明 ``` feat: allow provided config object to extend other configs @@ -52,7 +51,7 @@ docs: correct spelling of CHANGELOG feat(lang): added polish language ``` -### 为 fix 编写的提交说明，包含可选的 issue 编号 +### 为 fix 编写的提交说明，包含（可选的） issue 编号 ``` fix: minor typos in code @@ -63,55 +62,55 @@ fixes issue #12 ## 介绍 -在软件开发中，个人的经验是 bug 最常由应用间的边界引入。对单元测试而言，在所测试的交互处在开源维护者知识范围内时，它工作得很好。但在刻画社区里各种有趣而常在预料之外的使用场景时，它就显得比较糟糕了。 +在软件开发中，以我个人的经验来说，bug 最常产生在应用间的边界情况中。单元测试在开源维护者已知的交互场景下工作得很好。但对于社区中各种有趣且常常是意想不到的方式使用类库的情况，它就覆盖得比较差了。 -任何在升级新依赖 patch 版本后发现应用开始抛出稳定 500 错误流的人，都知道可读的提交历史（以及[理想条件下高质量维护的 CHANGELOG](http://keepachangelog.com/en/0.3.0/)）有多重要。 +那些经历过在升级了一个依赖新的 patch 版本后，发现自己的应用竟开始抛出稳定的 500 错误流的人，都明白一个可读的提交历史（以及[理想的维护良好的 CHANGELOG](http://keepachangelog.com/en/0.3.0/)）对于排错有多重要。 -约定式的提交规范提议在提交说明的基础上，引入标准化的轻量约定。这个约定和 [SemVer](http://semver.org) 相吻合，要求开发者在提交信息中描述新特性、bug 修复和破坏性更新。 +约定式的提交规范提议在提交说明的基础上，引入一种标准化的轻量级约定。这个约定和 [SemVer](http://semver.org) 相吻合，它要求开发者在提交信息中描述他们所改动的新特性、bug 修复和破坏性变更。 -引入这一约定后，我们可以创建一种通用的语言，简化在项目边界之间调试的问题。 +引入这一约定后，我们可以创建一种通用的语言，更易于在项目边界间调试问题。 ## 约定式提交规范 -本文档中的关键词 “必须”、“禁止”、“需要”、“应当”、“不应当”、“应该”、“不应该”、“推荐”、“可以” 和 “可选” 应按照 [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) 的描述解释。 +本文中的关键词 “必须（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` 或 `fix` ，其后接冒号（英文半角）和空格。 1. 当一个提交为应用或类库实现了新特性时，**必须**使用 `feat` 类型。 1. 当一个提交为应用修复了 bug 时，**必须**使用 `fix` 类型。 -1. 可选的作用域字段**可以**在类型后提供。作用域是描述代码库中某个部分的词组，封装在括号中，形如 `fix(parser):` 等。 -1. 描述字段**必须**紧接在类型或作用域前缀之后。描述指的是对代码变更的简短描述，形如 _fix: array parsing issue when multiple spaces were contained in string._ +1. 可选的作用域字段**可以**在类型后提供。作用域是描述代码库中某个部分的词组，封装在圆括号中，例如： `fix(parser):`。 +1. 描述字段**必须**紧接在类型或作用域前缀之后。描述指的是对代码变更的简短描述，例如： _fix: array parsing issue when multiple spaces were contained in string._ 1. 在简短描述之后，**可以**编写更长的提交正文，为代码变更提供额外的上下文信息。正文**必须**起始于描述字段结束的一个空行后。 -1. 在正文结束的一个空行后，**可以**编写脚注（如果正文缺失，可以编写在描述之后）。脚注**应当**为代码变更包含额外的 issue 引用信息（例如它所修复的 issue，类似 `Fixes #13` 等）。 +1. 在正文结束的一个空行后，**可以**编写脚注（如果没有正文，可以编写在描述之后）。脚注**应当**为代码变更包含额外的 issue 引用信息（比如它所修复的 issue，例如： `Fixes #13`）。 1. 破坏性变更**必须**在提交的正文或脚注加以展示。一个破坏性变更**必须**包含大写的文本 `BREAKING CHANGE`，紧跟冒号和空格。 -1. 在 `BREAKING CHANGE: ` 之后**必须**提供描述，以描述对 API 的变更。例如 _BREAKING CHANGE: environment variables now take precedence over config files._ -1. 脚注**必须**只包含 `BREAKING CHANGE`、外部链接、issue 引用和其它元数据信息。 +1. 在 `BREAKING CHANGE: ` 之后**必须**提供描述，以描述对 API 的变更。例如： _BREAKING CHANGE: environment variables now take precedence over config files._ +1. 脚注**必须**只包含 `BREAKING CHANGE`、外部链接、issue 引用和其它元信息。 1. 在提交说明中，**可以**使用 `feat` 和 `fix` 之外的类型。 ## 为什么使用约定式提交 * 自动化生成 CHANGELOG。 * 基于提交的类型，自动决定语义化的版本变更。 -* 向同事、公众与其他利益关系人传达变化的性质。 +* 向同事、公众与其他利益关系者传达变化的性质。 * 触发构建和部署流程。 -* 让人们更容易地探索结构化的提交历史，降低贡献项目的难度。 +* 让人们探索一个更加结构化的提交历史，以便降低对你的项目做出贡献的难度。 ## FAQ -### 如何处理初始开发阶段的提交说明？ +### 在初始开发阶段我该如何处理提交说明？ -我们建议你按照已发布的产品那样来处理。一般情况下即便是开发者同事，也*有人*使用你的软件。他们会希望知道诸如修复了什么、哪里不兼容等信息。 +我们建议你按照假设你已发布了产品那样来处理。因为通常总 *有人* 使用你的软件，即便那是你软件开发的同事们。他们会希望知道诸如修复了什么、哪里不兼容等信息。 -### 提交符合一或多种类型时该如何处理？ +### 如果提交符合多种类型我该如何操作？ -回退并尽可能创建多次提交。约定式提交的部分好处是能够促使我们做出更有组织的提交和 PR。 +回退并尽可能创建多次提交。约定式提交的好处之一是能够促使我们做出更有组织的提交和 PR。 -### 这不会阻碍快速的开发和迭代吗？ +### 这不会阻碍快速开发和迭代吗？ -它阻碍的是以杂乱无章的方式快速前进。它帮助我们在横跨长时间周期、多个项目、多个贡献者时能够保持效率。 +它阻碍的是以杂乱无章的方式快速前进。它助你能在横跨多个项目以及和多个贡献者协作时长期地快速演进。 -### 约定式提交会让开发者受限于提交的类型吗？ +### 约定式提交会让开发者受限于提交的类型吗（因为他们会想着已提供的类型）？ -约定式提交鼓励我们更多地使用某些类型的提交，比如 fixes。除此之外，约定式提交的灵活性也允许你的团队使用自己的类型，并随着时间的推移更改这些类型。 +约定式提交鼓励我们更多地使用某些类型的提交，比如 `fixes`。除此之外，约定式提交的灵活性也允许你的团队使用自己的类型，并随着时间的推移更改这些类型。 ### 这和 SemVer 有什么关联呢？ @@ -123,17 +122,17 @@ fixes issue #12 ### 如果我不小心使用了错误的提交类型，该怎么办呢？ -#### 当你使用了在规范中但错误的类型时，如将 `feat` 写成了 `fix` +#### 当你使用了在规范中但错误的类型时，例如将 `feat` 写成了 `fix` 在合并或发布这个错误之前，我们建议使用 `git rebase -i` 来编辑提交历史。而在发布之后，根据你使用的工具和流程不同，会有不同的清理方案。 -#### 当使用了*不*在规范中的类型时，如将 `feat` 写成了 `feet` +#### 当使用了*不*在规范中的类型时，例如将 `feat` 写成了 `feet` -在最坏的场景下，即便提交没有满足约定式提交的规范，也不是世界的终结。这只意味着这个提交会被基于规范的工具错过而已。 +在最坏的场景下，即便提交没有满足约定式提交的规范，也不会是世界末日。这只意味着这个提交会被基于规范的工具错过而已。 ### 所有的贡献者都需要使用约定式提交规范吗？ -并不！如果你使用基于 squash 的 Git 工作流，主管维护者可以在合并时清理提交信息——这不会对普通提交者产生额外的负担。有种常见的工作流是让 git 系统自动从 pull request 中 squash 出提交，向主管维护者提供表单，来在合并时输入合适的 git 提交信息。 +并不！如果你使用基于 squash 的 Git 工作流，主管维护者可以在合并时清理提交信息——这不会对普通提交者产生额外的负担。有种常见的工作流是让 git 系统自动从 pull request 中 squash 出提交，并向主管维护者提供一份表单，用以在合并时输入合适的 git 提交信息。 ## 关于 @@ -144,15 +143,16 @@ fixes issue #12 * [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)：一套从 git 历史中解析出约定式提交说明的工具。 * [unleash](https://github.com/netflix/unleash)：一个用于自动化软件发行和发布生命周期的工具。 -* [lerna](https://github.com/lerna/lerna)：一个用于管理宏仓库的工具，源自 Babel 项目。 +* [lerna](https://github.com/lerna/lerna)：一个用于管理宏仓库（monorepo）的工具，源自 Babel 项目。 ## 使用约定式提交的项目 * [yargs](https://github.com/yargs/yargs)：广受欢迎的命令行参数解析器。 +* [parse-commit-message](https://github.com/olstenlarck/parse-commit-message): 一个符合规范的解析工具，从给定的某个提交信息字符串中解析出形如 `{ header: { type, scope, subject }, body, footer }` 的对象。 * [istanbuljs](https://github.com/istanbuljs/istanbuljs)：一套为 JavaScript 测试生成测试覆盖率的开源工具和类库。 * [standard-version](https://github.com/conventional-changelog/standard-version) 基于 GitHub 的新 squash 按钮与推荐的约定式提交工作流，自动管理版本和 CHANGELOG。 * [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) 的可选用户界面。 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) -_想让你的项目出现在上面吗？_[提交 pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls) 吧。 +_想让你的项目出现在上面吗？_ [提交 pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls) 吧。 diff --git a/content/v1.0.0-beta.3/index.zh.md b/content/v1.0.0-beta.3/index.zh.md new file mode 100644 index 0000000..f4d8fde --- /dev/null +++ b/content/v1.0.0-beta.3/index.zh.md @@ -0,0 +1,172 @@ +--- +draft: false +aliases: ["/zh/"] +--- + +# 约定式提交 1.0.0-beta.3 + +## 概述 + +约定式提交规范是一种基于提交消息的轻量级约定。 +它提供了一组用于创建清晰的提交历史的简单规则； +这使得编写基于规范的自动化工具变得更容易。 +这个约定与 [SemVer](http://semver.org) 相吻合， +在提交信息中描述新特性、bug 修复和破坏性变更。 + +提交说明的结构如下所示： + +--- + +``` +<类型>[可选的作用域]: <描述> + +[可选的正文] + +[可选的脚注] +``` +--- + +
+提交说明包含了下面的结构化元素，以向类库使用者表明其意图： + +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)）中推荐的 `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 +``` + +## 约定式提交规范 + +本文中的关键词 “必须（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. 在正文结束的一个空行后，**可以**编写脚注。 + 脚注**应当**为代码变更包含额外的 issue 引用信息（比如它所修复的 issue，例如： `Fixes #13`）。 +1. 破坏性变更**必须**在提交的正文或脚注加以展示。一个破坏性变更**必须**包含大写的文本 `BREAKING CHANGE`，紧跟冒号和空格。 +1. 在 `BREAKING CHANGE: ` 之后**必须**提供描述，以描述对 API 的变更。例如： _BREAKING CHANGE: environment variables now take precedence over config files._ +1. 脚注**必须**只包含 `BREAKING CHANGE`、外部链接、issue 引用和其它元信息。 +1. 在提交说明中，**可以**使用 `feat` 和 `fix` 之外的类型。 + +## 为什么使用约定式提交 + +* 自动化生成 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 提交信息。 + +## 关于 + +约定式提交规范受到了 [Angular 提交准则](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit)的启发，并在很大程度上以其为依据。 + +该规范的首个草案来自下面这些项目中若干贡献者们的协作： + +* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)：一套从 git 历史中解析出约定式提交说明的工具。 +* [bumped](https://bumped.github.io)：一个用于发布软件的工具，可以在为你的软件发布新版本前后轻松地执行操作。 +* [unleash](https://github.com/netflix/unleash)：一个用于自动化软件发行和发布生命周期的工具。 +* [lerna](https://github.com/lerna/lerna)：一个用于管理宏仓库（monorepo）的工具，源自 Babel 项目。 + +## 用于约定式提交的工具 + +* [php-commitizen](https://github.com/damianopetrungaro/php-commitizen)：一个用于创建遵循约定式提交规范提交信息的工具。 +可配置，并且可以作为 composer 依赖项用于 PHP 项目，或可在非 PHP 项目中全局使用。 +* [conform](https://github.com/autonomy/conform)：一个可用以在 git 仓库上施加配置的工具，包括约定式提交。 + +## 使用约定式提交的项目 + +* [yargs](https://github.com/yargs/yargs)：广受欢迎的命令行参数解析器。 +* [istanbuljs](https://github.com/istanbuljs/istanbuljs)：一套为 JavaScript 测试生成测试覆盖率的开源工具和类库。 +* [standard-version](https://github.com/conventional-changelog/standard-version) 基于 GitHub 的新 squash 按钮与推荐的约定式提交工作流，自动管理版本和 CHANGELOG。 +* [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)：一个开源的人际关系管理系统。 + +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) + +_想让你的项目出现在上面吗？_ [提交 pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls) 吧。