resin

🔥 针对约定提交格式的超快 CLI 工具

❓ 什么是 resin？

resin 是一个 CLI（命令行界面）工具，可以轻松创建遵循 约定提交格式 的提交信息。以下是一个小演示

此演示将创建以下提交信息

feat(config): add crates.io fields

✨ 新功能

🚩 标志

resin 有三个标志

1. --help (-h) -> 在终端显示帮助信息
2. --all (-a) -> 在提交更改之前运行 git add .
3. --push (-p) -> 在提交更改之后运行 git push

超级简单且易于使用！

⚙️ 配置

📖 范围

您可以配置 resin 以拥有自定义的范围。以下是一个配置示例

scopes = ['docker', 'github actions']

✍️ 签署信息

您还可以有一个基于您的 ~/.gitconfig 文件内容的签署信息

sign = true

这将创建一个消息，会自动添加到您的提交信息底部

Signed-off-by: Matt Gleich <[email protected]>

📁 位置

此文件可以存储在 ~/.config/resin/config.toml 或在项目根目录中，以相同名称存储每个项目的配置。您可以在此项目中查看此示例

🚀 安装

您可以使用 cargo 安装 resin

cargo install resin

🙌 贡献

我们非常希望您能做出贡献！在提交拉取请求之前，请阅读贡献指南。提前感谢您！

👥 贡献者

• @gleich

• @Liberatys