commit-linter

An easy to use tool to that lints your commit messages according to commit conventions .

commit-linter is a Python tool that helps you standardize your commit messages to a known commit conventions. the tool also add emojies to your commits.

Installation

Use the package manager pip to install commit-linter.

pip install commit-linter

Usage

in your git repository just execute

commit-linter

or

commit-linter install

if you want to remove the hook, just execute

commit-linter remove

How it works

commit-linter uses git-hooks which are scripts that exists in each repository. Take a look at any repo you have, you will have .git directory, and inside you will find hooks directory, commit-linter just puts a simple script named commit-msg inside that directory and makes it executable so each time you right a commit message it will get linted as per the conventions, you can look at script in your repository inside .git/hooks path.

Read more about Git Hooks.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This Tool is Under MIT License.