cz_legacy

[!注意] 使用 commitizen 几年后，cz_legacy 对旧年变更日志的实用性变得不那么重要。根据公开代码，此包似乎仅在我的项目中使用，因此将被存档。如果您有此项目或相关问题，请随时在此提交问题并标记我（@kyleking）：[https://github.com/KyleKing/calcipy](https://github.com/KyleKing/calcipy)

用户指定旧更改类型的自定义Commitizen解析器。解析器使用cz_conventional_commits模式，并通过配置文件中指定的标签映射进行扩展。

虽然旧更改类型将出现在“变更日志”中，但用户将无法在新提交中使用它们。这与commitizen中revert/chore逻辑相反，该逻辑允许使用这些提交类型，但不会在变更日志中显示。

备选方案

此自定义功能仅在旧提交使用可以由commitizen解析的格式（<change_type>: <message>）时才有效。如果这不符合您的用例，您可以尝试使用增量，它（我认为）会在现有的CHANGELOG前添加内容。

使用方法

预提交

要在预提交中使用，请将其添加到您的pre-commit-config.yml文件中。运行pre-commit autoupdate以获取最新版本。

repos:
  - repo: https://github.com/commitizen-tools/commitizen
    rev: main
    hooks:
      - id: commitizen
        additional_dependencies: [cz_legacy]
        stages: [commit-msg]

配置

至少，您必须在配置文件中包含name = "cz_legacy"和[tool.commitizen.cz_legacy_map]。以下示例适用于TOML，您也可以使用YAML或JSON文件。

以下是三种变更遗留类型Chg、Fix和New的示例，但用户可以选择任何标签名称及其相关映射用于变更日志。

[tool.commitizen]
name = "cz_legacy"
# Other tool.commitizen configuration options

[tool.commitizen.cz_legacy_map]
Chg = "Change (old)"
Fix = "Fix (old)"
New = "New (old)"

问题

如果您有任何功能请求、遇到任何错误或有任何问题，请随时在Github上https://github.com/kyleking/cz_legacy开始讨论或创建问题。

项目状态

请参阅Open Issues和/或CODE_TAG_SUMMARY。有关发布历史，请参阅CHANGELOG。

贡献

我们欢迎拉取请求！为了使您的拉取请求顺利接受，我们建议您首先在GitHub问题中讨论您的想法。有关开始代码库的资源，请参阅以下文档。

• DEVELOPER_GUIDE
• STYLE_GUIDE

行为准则

我们遵循Contributor Covenant行为准则。

开源状态

我们努力合理地满足“OpenSSF scorecard”的大部分方面，该scorecard来自Open Source Insights。

负责任地披露

如果您有任何安全问题要报告，请私下联系项目维护者。您可以通过dev.act.kyle@gmail.com联系我们。

许可协议

许可证