dotfiles/zsh/.oh-my-zsh/plugins/git-commit/README.md

git-commit plugin

The git-commit plugin adds several git aliases for conventional commit messages.

To use it, add git-commit to the plugins array in your zshrc file:

plugins=(... git-commit)

Syntax

git <type> [(-s, --scope) "<scope>"] [(-a, --attention)] "<message>"

Where type is one of the following:

• build
• chore
• ci
• docs
• feat
• fix
• perf
• refactor
• rev
• style
• test
• wip

NOTE: the alias for revert type is rev, as otherwise it conflicts with the git command of the same name. It will still generate a commit message in the format revert: <message>

⚠️ Enabling this plugin will (potentially) overwrite all alias.<type> that you manually set. Use with care!

Examples

Git alias	Command
git style "remove trailing whitespace"	git commit -m "style: remove trailing whitespace"
git wip "work in progress"	git commit -m "work in progress"
git fix -s "router" "correct redirect link"	git commit -m "fix(router): correct redirect link"
git rev -s "api" "rollback v2"	git commit -m "revert(api): rollback v2"