cz-pydata

Commitizen 是一个命令行工具，帮助您创建自己的规则集，用于生成一致的提交、提升项目版本或自动生成变更日志。

PyData 是科学Python社区项目的总称，包括NumPy、SciPy和Pandas。其中一些项目使用从NumPy开发指南派生的提交消息约定，这些约定将被称为《PyData约定》。

Keep a Changelog 是编写结构化和可读变更日志的规范。据我所知，目前尚无工具可以将PyData风格的提交消息自动转换为结构化变更日志。

此插件扩展了Commitizen的功能

• 理解或生成遵循PyData约定的提交消息。
• 根据这些提交消息提升项目的语义版本。
• 根据KaC规范自动生成结构化变更日志。

目录

• 安装
• 使用方法
• 许可证

安装

使用pip

pip install cz-pydata

使用pipx

pipx install commitizen
pipx inject commitizen cz-pydata

使用pre-commit

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/commitizen-tools/commitizen
    rev: master  # TODO: Replace by latest version
    hooks:
      - id: commitizen
        additional_dependencies: [ cz-pydata ]

使用方法

要使用此插件与Commitizen CLI一起使用

cz --name cz_pydata <command>

配置

您可以通过在您的 pyproject.toml 中添加以下设置来配置您的项目以使用这些提交规则

[tool.commitizen]
name = "cz_pydata"

此外，您可能希望在版本升级时自定义提交信息，以支持使用

bump_message = "REL: Release version $new_version"

其他配置选项请参阅Commitizen 文档。您可以随意查看此项目的 Commitizen 配置，并根据您的需求进行修改。

许可证

cz-pydata 依据MIT 许可协议进行分发。