使用 commitizen 格式化 commit message

在做项目时，每次进行 git commit -m 'xxx' 都会想给提交起一个合适的名字，当次数多了之后，内容也会变的混乱。当某一天系统出错了，看着那么多的提交记录，可能也不清楚应该要回溯到那个版本。

撰写好的 commit message，除了让未来的自己知道自己是在干嘛，也能让团队之间的沟通更加顺利。在提交 Pull Request / Merge Request 时，审核者能更快第知道增加了那些功能。新成员看着以往的 commit message 也能找到项目的脉络，更容易上手。

Commitizen

https://commitizen-tools.github.io/commitizen/

除了提供 commit message 撰写的建议与规范，commitizen 更进一步提供了交互式的界面，让使用者可以轻松生成符合规范的 commit message。

除了采取来自 Angular 社区的Conventional Commits(约定式提交) 外，commitizen 还提供了可定制化的功能，能让每个团队或者项目都可以依照自己的需求，便携相对应的规范。规范了 commit message 后，除了增加可读性外，也让信息可以被解析做其他运用。例如提升版本号、产生更新日志。

安装与设定 Commitizen

安装

poetry add commitizen --group dev

第一次在项目中使用 commitizen 可以使用初始化指令来完成基本的配置

cz init

1、选择配置文件存放的位置。这里直接选 pyproject.toml 了，也可以使用单独的配置。

$ cz init
Welcome to commitizen!

Answer the questions to configure your project.
For further configuration visit:

https://commitizen-tools.github.io/commitizen/config/

? Please choose a supported config file:  (Use arrow keys)
 » pyproject.toml
   .cz.toml
   .cz.json
   cz.json
   .cz.yaml
   cz.yaml

2、选择提交风格。默认的提交风格有三种，如果不满意也可以自己选择第三方模板。这里我选择 cz_conventional_commits

? Please choose a cz (commit rule): (default: cz_conventional_commits) (Use arrow keys)
 » cz_conventional_commits
   cz_customize
   cz_jira

3、选择版本的来源。直接使用默认的 poetry 了。

? Choose the source of the version: (Use arrow keys)
   commitizen: Fetch and set version in commitizen config (default)
   cargo: Get and set version from Cargo.toml:project.version field
   composer: Get and set version from composer.json:project.version field
   npm: Get and set version from package.json:project.version field
   pep621: Get and set version from pyproject.toml:project.version field
 » poetry: Get and set version from pyproject.toml:tool.poetry.version field
   scm: Fetch the version from git and does not need to set it back

4、选择版本方案。选择默认

? Choose version scheme:  (Use arrow keys)
   semver
 » pep440

5、输入版本的格式如何，常用的格式有$version(1.0.0) 或v$version(v1.0.0)。回车默认就好了。

? Please enter the correct version format: (default: "$version")

6、使用 bump 指令是自动更新日志，回车默认

? Create changelog automatically on bump Yes

7、在重大变更时保持当前大版本，回车默认

? Keep major version zero (0.x) during breaking changes Yes

8、选择那一种钩子进行提交，回车默认

? What types of pre-commit hook you want to install? (Leave blank if you don't want to install) (Use arrow keys to move, <space> to select, <a> to toggle, <i> to i
nvert)
 » ○ commit-msg
   ○ pre-push

全部设置完了之后，就会在 pyproject.toml 文件中生成一下内容

[tool.commitizen]
name = "cz_conventional_commits"
tag_format = "$version"
version_scheme = "pep440"
version_provider = "poetry"
update_changelog_on_bump = true
major_version_zero = true