1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-23 21:01:58 +00:00
ohmyzsh/plugins/git-commit/README.md
Oscar Lee-Vermeren 1abc1d998a
feat(git-commit): create plugin (#9646)
Co-authored-by: K. Akatsuki <thevortexspirit@gmail.com>
2023-09-04 19:21:27 +02:00

851 B

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
  • revert
  • style
  • test

Examples

git style "remove trailing whitespace" -> git commit -m "style: remove trailing whitespace"
git fix -s "router" "correct redirect link" -> git commit -m "fix(router): correct redirect link"