About commitlint
A lightweight, fast, and cross-platform CLI tool for linting Git commit messages.
Linting commit messages helps maintain a consistent commit history, which is critical for readability, automation, and collaboration across teams. commitlint ensures your commits follow a defined convention, making your Git logs cleaner and easier to work with.
Features
Section titled “Features”- ⚡ Fast and lightweight: Built for performance.
- 💻 Cross-platform support: Works on Windows, macOS, and Linux.
- 📦 Easy installation: Install with a single command per OS.
- 🔧 Project-level integration: Add to your project with
commitlint install
. - 💉 Plugin system: Simple & intuitive.
Contributing
Section titled “Contributing”We welcome contributions! Please fork the repository and submit a pull request. Be sure your commits follow the linting rules — after all, that’s the point!
Troubleshooting
Section titled “Troubleshooting”- CLI not found after install?
Make sure the install location is in your system’sPATH
.
License
Section titled “License”This project is licensed under the MIT License.