git-sumi
| Crates.io | git-sumi |
| lib.rs | git-sumi |
| version | 0.0.9 |
| source | src |
| created_at | 2024-02-04 17:01:43.075836 |
| updated_at | 2024-05-06 22:47:11.93043 |
| description | Non-opinionated commit message linter |
| homepage | https://sumi.rs |
| repository | https://github.com/welpo/git-sumi |
| max_upload_size | |
| id | 1126510 |
| size | 2,144,977 |
Óscar (welpo)
documentation
README
Documentation | Website
git-sumi
The non-opinionated Rust-based commit message linter
Transform your commit practices with flexible linting for consistently high-quality Git commit messages that adhere to your project's standards.
sumi (墨, /sɯmi/): ink, especially the type used in traditional ink wash painting.
🎥 Demo
See how git-sumi can help you write better commit messages:
https://github.com/welpo/git-sumi/assets/6399341/cf1b4f00-3f79-454f-a533-5b36812dd464
✨ Main features
-
Customizable rules: Tailor git-sumi to each project's specific requirements. Easily configure rules to enforce Conventional Commits, length limits, gitmoji usage, and more through a simple TOML file.
-
Clear error reporting: git-sumi's detailed error reporting makes fixing commit messages straightforward and educational.
-
Seamless integration: git-sumi is a single binary, making it easy to integrate into your existing workflow with minimal setup.
📝 Documentation
Learn how to use git-sumi from the documentation.
👥 Contributing
Please do! Contributions are always welcome. We appreciate improvements to the documentation, development of new rules, code cleanup, resolving issues, requesting or developing new functionality…
Take a look at our Contributing Guidelines for more information on how to get started.
📄 License
This project is licensed under the terms of both the MIT license and the Apache License (Version 2.0), at your option.