diff options
| author | Carlo Sala <carlosalag@protonmail.com> | 2024-03-02 10:05:54 +0100 |
|---|---|---|
| committer | Carlo Sala <carlosalag@protonmail.com> | 2024-03-02 10:05:54 +0100 |
| commit | 458fc2e1df4757e64b036edee17ccdefdde41f73 (patch) | |
| tree | 29ccbd2c7d102d98147946a8e3114739d2301846 | |
| parent | b6c1de87b01aaf5eb434b86b1d32b92cb37467bb (diff) | |
| download | zsh-458fc2e1df4757e64b036edee17ccdefdde41f73.tar.gz zsh-458fc2e1df4757e64b036edee17ccdefdde41f73.tar.bz2 zsh-458fc2e1df4757e64b036edee17ccdefdde41f73.zip | |
docs(git-commit): add warning
| -rw-r--r-- | plugins/git-commit/README.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/plugins/git-commit/README.md b/plugins/git-commit/README.md index 49072d0fb..f812ee23f 100644 --- a/plugins/git-commit/README.md +++ b/plugins/git-commit/README.md @@ -1,6 +1,8 @@ # git-commit plugin -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. +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. To use it, add `git-commit` to the plugins array in your zshrc file: @@ -14,8 +16,6 @@ plugins=(... git-commit) git <type> [(-s, --scope) "<scope>"] [(-a, --attention)] "<message>" ``` -> ⚠️ Single/Double quotes around the scope and message are required - Where `type` is one of the following: - `build` @@ -34,6 +34,9 @@ Where `type` is one of the following: > 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 | |