Skip to content

A configurable Git hook for adhering to the Conventional Commit specification

License

Notifications You must be signed in to change notification settings

tapsellorg/conventional-commits-git-hook

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Conventional Commits Git Hook

This tool helps you follow the Conventional Commits conventional by installing a configurable commit-msg into your Git projects.

Installing

curl -o- https://raw.githubusercontent.com/tapsellorg/conventional-commits-git-hook/master/scripts/install.sh | sh

In Windows, you can run this command in a "Git Bash" terminal.

Uninstalling

Remove the commit-msg Git hook from your project:

rm <your-project>/.git/hooks/commit-msg

Usage

Once installed, you must run git init in your Git projects to (re)initialize your repository.

Supported types:

["build", "docs", "feat", "fix", "perf", "refactor", "style", "test", "chore"]

Note: you can disable this hook per commit by using --no-verify. Which is not recommended.

IDE Plugins

About

A configurable Git hook for adhering to the Conventional Commit specification

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 80.0%
  • Python 11.7%
  • Makefile 8.3%