commit-msg-validator

A pre-commit hook to validate commit messages

Keywords

Keyword	Meaning
$feat$	a new feature is introduced with the changes
$fix$	a bug fix has occurred
$chore$	changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies)
$refactor$	refactored code that neither fixes a bug nor adds a feature
$docs$	updates to documentation such as a the README or other markdown files
$style$	changes that do not affect the meaning of the code, likely related to code formatting such as white-space, missing semi-colons, and so on.
$test$	including new or correcting previous tests
$perf$	performance improvements
$ci$	continuous integration related
$build$	changes that affect the build system or external dependencies
$revert$	reverts a previous commit

valid commit message format

The basic structure of the message format is

type(scope): message

In this type and message are mandatory, and scope can be empty so for example these are valid commit message format

feat(app): added feature to list users
fix: resolved the issue with the connection layer

These are Invalid

added feature to list users  ( no type specified )
fix:    ( no message specified )
fix(app: added feature to list users (didnt close the bracket)
something: msg (invalid type keyword)

Command to test on dev

pre-commit try-repo . --commit-msg-filename commit_message.txt --hook-stage commit-msg