Non-opinionated Rust-powered commit message linter
Project description
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/746aa468-680c-44d1-9143-c048b5e88594
✨ 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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for git_sumi-0.0.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b02c1bea0f48e9910ca4baf2c1513e97353bbbe812197aa245dabedbe6b2b18 |
|
MD5 | a0ca8a66e927f384ad9d241b10f98c9d |
|
BLAKE2b-256 | 32d683d6a074167ce43d36c858634e0e8e4325d0aceb433aa302c09e234efaf1 |
Hashes for git_sumi-0.0.4-py3-none-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62c5e2dc40eeb9749822a56338b235d81a2b85c26db054c48b1e163851922d67 |
|
MD5 | 7bae10f1f79cac295b3664963aa2b451 |
|
BLAKE2b-256 | 49ba467a592ce0d55645ced71baeed7788d1633ebf2a5dd21a9fd524343063c1 |