From 048455ccefdc67c4f137b8f7886769c55c2e5417 Mon Sep 17 00:00:00 2001
From: Marc Cornellà <marc@mcornella.com>
Date: Wed, 25 Oct 2023 19:47:10 +0200
Subject: fix(git-commit): fix revert alias conflict (#12007)

Fixes #12007
---
 plugins/git-commit/README.md | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

(limited to 'plugins/git-commit/README.md')

diff --git a/plugins/git-commit/README.md b/plugins/git-commit/README.md
index dc10d8ad5..91cc73b44 100644
--- a/plugins/git-commit/README.md
+++ b/plugins/git-commit/README.md
@@ -10,7 +10,7 @@ plugins=(... git-commit)
 
 ## Syntax
 
-```zshrc
+```zsh
 git <type> [(-s, --scope) "<scope>"] "<message>"
 ```
 
@@ -26,11 +26,17 @@ Where `type` is one of the following:
 - `fix`
 - `perf`
 - `refactor`
-- `revert`
+- `rev`
 - `style`
 - `test`
 
+> 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 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"`
+| Git alias                                     | Command                                              |
+| --------------------------------------------- | ---------------------------------------------------- |
+| `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"` |
+| `git rev -s "api" "rollback v2"`              | `git commit -m "revert(api): rollback v2"`           |
-- 
cgit v1.2.3-70-g09d2