commitizen

---

文档： https://commitizen-tools.github.io/commitizen/

---

关于

Commitizen是为团队设计的发布管理工具。

Commitizen假设您的团队使用标准的提交规则，并以此为基础，可以升级项目版本、创建更新日志和更新文件。

默认情况下，Commitizen使用约定式提交，但您也可以构建自己的规则集并发布它们。

使用标准化的规则集来编写提交信息，可以使提交更易读，并强制编写描述性的提交。

特性

• 命令行工具，用于按照您的规则创建提交。默认：约定式提交
• 基于提交自动使用语义化版本升级版本。了解更多
• 使用Keep a changelog生成更新日志
• 自动更新项目的版本文件
• 显示有关您的提交规则的信息（命令：schema、example、info）
• 创建您自己的规则集并将其发布到pip。在自定义中了解更多

要求

Python 3.8+

Git 1.8.5.2+

安装

要在您的系统中使用Commitizen，请执行以下操作：

pip install --user -U Commitizen

Python项目

您可以使用以下方法之一将其添加到本地项目：

pip install -U commitizen

对于Poetry >= 1.2.0：

poetry add commitizen --group dev

对于Poetry < 1.2.0：

poetry add commitizen --dev

macOS

通过homebrew：

brew install commitizen

使用

大多数情况下，您只需运行此命令：

cz bump

此外，您还可以使用Commitizen来协助创建提交：

cz commit

在入门部分阅读更多内容。

帮助

$ cz --help
用法：cz [-h] [--debug] [-n NAME] [-nr NO_RAISE] {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...

Commitizen是一个用于生成约定式提交的命令行工具。
有关该主题的更多信息，请访问https://conventionalcommits.org/

可选参数：
  -h, --help            显示此帮助信息并退出
  --config              配置文件的路径
  --debug               使用调试模式
  -n NAME, --name NAME  使用给定的commitizen（默认：cz_conventional_commits）
  -nr NO_RAISE, --no-raise NO_RAISE
                        以逗号分隔的不会引发错误的错误代码，例如：cz -nr 1,2,3 bump。查看 https://commitizen-tools.github.io/commitizen/exit_codes/ 了解错误代码

命令：
  {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
    init                初始化commitizen配置
    commit (c)          创建新的提交
    ls                  显示可用的commitizen
    example             显示提交示例
    info                显示有关cz的信息
    schema              显示提交模式
    bump                基于git日志升级语义化版本
    changelog (ch)      生成更新日志（请注意，它将覆盖现有文件）
    check               验证提交消息是否符合commitizen模式
    version             获取已安装的commitizen或当前项目的版本（默认：已安装的commitizen）

设置bash自动补全

当使用bash作为shell时（对zsh、fish和tcsh有限支持），Commitizen可以使用argcomplete进行自动补全。为此，需要启用argcomplete。

安装Commitizen时会安装argcomplete，因为它是一个依赖项。

如果Commitizen是全局安装的，可以执行全局激活：

sudo activate-global-python-argcomplete

对于永久（但非全局）Commitizen激活，使用：

register-python-argcomplete cz >> ~/.bashrc

对于仅Commitizen的一次性激活，使用：

eval "$(register-python-argcomplete cz)"

有关激活的更多信息，请访问argcomplete网站。

赞助商

这些是我们出色的赞助商！

<!-- sponsors --><!-- sponsors -->