文档 | 网站

git-sumi

基于 Rust 的非观点提交信息代码检查器

使用灵活的代码检查，将您的提交实践转变为符合项目标准的高质量 Git 提交信息。

sumi (墨, /sɯmi/): 墨，尤其是在 传统水墨画 中使用的墨。

🎥 演示

看看 git-sumi 如何帮助您编写更好的提交信息

https://github.com/welpo/git-sumi/assets/6399341/cf1b4f00-3f79-454f-a533-5b36812dd464

✨ 主要功能

• 自定义规则：将 git-sumi 定制为每个项目的特定要求。通过简单的 TOML 文件轻松配置 规则，强制执行 常规提交、长度限制、gitmoji 使用等。

• 清晰的错误报告：git-sumi 的详细错误报告使修复提交信息变得简单且具有教育意义。

• 无缝集成：git-sumi 是一个单一的二进制文件，易于通过最小设置 集成到现有工作流程。

📝 文档

从 文档 中了解如何使用 git-sumi。

• 快速设置
• 配置
• 规则
• 示例
• 集成
• 常见问题解答

👥 贡献

请随时贡献！我们欢迎对文档、新规则的开发、代码清理、解决问题、请求或开发新功能等方面的改进。

请查看我们的 贡献指南 了解如何开始。

📄 许可证

本项目根据您的要求，同时遵循 MIT 协议 和 Apache 许可协议（版本 2.0）。