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/cytomine/conventional-commits-git-hook/master/scripts/install.sh | bash

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:

["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

• JetBrains Conventional Commit
• VS Code Conventional Commit