458fc2e1df4757e64b036edee17ccdefdde41f73

Author
Carlo Sala <carlosalag@protonmail.com>
Committer
Carlo Sala <carlosalag@protonmail.com>
Date

Message

docs(git-commit): add warning

Diff

 1diff --git a/plugins/git-commit/README.md b/plugins/git-commit/README.md
 2index 49072d0fbf5b2081ae452e02775b90260c0379f7..f812ee23f8ccef6a7bf49e54fe5d97d06b2c767f 100644
 3--- a/plugins/git-commit/README.md
 4+++ b/plugins/git-commit/README.md
 5@@ -1,6 +1,8 @@
 6 # git-commit plugin
 7 
 8-The git-commit plugin adds several [git aliases](https://www.git-scm.com/docs/git-config#Documentation/git-config.txt-alias) for [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) messages.
 9+The git-commit plugin adds several
10+[git aliases](https://www.git-scm.com/docs/git-config#Documentation/git-config.txt-alias) for
11+[conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) messages.
12 
13 To use it, add `git-commit` to the plugins array in your zshrc file:
14 
15@@ -14,8 +16,6 @@ plugins=(... git-commit)
16 git <type> [(-s, --scope) "<scope>"] [(-a, --attention)] "<message>"
17 ```
18 
19-> ⚠️ Single/Double quotes around the scope and message are required
20-
21 Where `type` is one of the following:
22 
23 - `build`
24@@ -34,6 +34,9 @@ Where `type` is one of the following:
25 > NOTE: the alias for `revert` type is `rev`, as otherwise it conflicts with the git command of the same name.
26 > It will still generate a commit message in the format `revert: <message>`
27 
28+> ⚠️ Enabling this plugin will (potentially) overwrite all `alias.<type>` that you manually set. Use with
29+> care!
30+
31 ## Examples
32 
33 | Git alias                                     | Command                                              |