diff options
Diffstat (limited to 'plugins/git-commit/README.md')
| -rw-r--r-- | plugins/git-commit/README.md | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/plugins/git-commit/README.md b/plugins/git-commit/README.md index 91cc73b44..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: @@ -11,11 +13,9 @@ plugins=(... git-commit) ## Syntax ```zsh -git <type> [(-s, --scope) "<scope>"] "<message>" +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` @@ -29,14 +29,19 @@ Where `type` is one of the following: - `rev` - `style` - `test` +- `wip` -> NOTE: the alias for `revert` type is `rev`, as otherwise it conflicts with the git command of the same name. +> 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 | | --------------------------------------------- | ---------------------------------------------------- | | `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"` | |