项目作者: hoopher

项目描述 :
commit-linter helps you lint your commit messages according to commit conventions
高级语言: Python
项目地址: git://github.com/hoopher/commit-linter.git
创建时间: 2021-01-19T17:19:24Z
项目社区:https://github.com/hoopher/commit-linter

开源协议:MIT License

下载


pypi
python
license
last-commit
downloads
PyPI - Wheel
PyPI - Implementation
PyPI - Format
Conventional Commits

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.

  1. pip install commit-linter

Usage

in your git repository just execute

  1. commit-linter

or

  1. commit-linter install

if you want to remove the hook, just execute

  1. 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.