rs-commitizien

rs-commitizien 是一个使用 Rust 编写的命令行工具，用于根据 Conventional Commit 标准验证提交消息。它有助于确保提交消息在项目中的一致性和清晰性，使人们更容易理解每个提交的目的。

安装

要安装 rs-commitizien，您需要在系统上安装 Rust 和 Cargo。安装完毕后，可以使用 Cargo 安装 rs-commitizien

cargo install rs-commitizien

使用

安装后，您可以使用 rs-commitizien 验证提交消息。只需导航到您的项目目录，并运行

rs-commitizien <commit-message>

将 <commit-message> 替换为您要验证的提交消息。工具将输出提交消息是否符合 Conventional Commit 标准。

Conventional Commit 标准

Conventional Commit 标准提供了一套用于格式化提交消息的规则。每个提交消息由一个标题、一个可选的正文和一个可选的尾部组成。标题具有特定的格式

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

其中

• type：描述所进行的更改类型（例如，feat、fix、docs）。
• scope（可选）：指定更改的范围（例如，组件、模块）。
• description：提供更改的简要总结。

更多信息请参阅 Conventional Commits。

示例

以下是一个有效的提交消息示例

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files