linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-12 21:39:48 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
ohmyzsh/plugins/git-commit
History
Carlo Sala e3216d15c2
fix(git-commit)!: allow alias update 
BREAKING CHANGE: Prior to this commit, git aliases were not being
updated after every update of oh-my-zsh. In case you were using
git-commit plugin before this commit, please remove your git aliases to
proceed.
2024-03-02 01:09:17 +01:00
..
git-commit.plugin.zsh fix(git-commit)!: allow alias update 2024-03-02 01:09:17 +01:00
README.md feat(git-commit): add wip kind (#12188) 2024-02-01 16:54:24 +01:00

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>"] "<message>"

⚠️ Single/Double quotes around the scope and message are required

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>

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"