summaryrefslogtreecommitdiff
path: root/plugins/git-commit/README.md
diff options
context:
space:
mode:
authorRejman Nascimento <72097727+rejmann@users.noreply.github.com>2024-02-01 12:54:24 -0300
committerGitHub <noreply@github.com>2024-02-01 16:54:24 +0100
commit4efad7ab1ba0d1715af62e484c6852808581cfb9 (patch)
tree0c3bae38c94a33c2babb305c7a49891e98b18c92 /plugins/git-commit/README.md
parente195c7cb438224e8bcea20bdbc2e4b8a6bb3949b (diff)
downloadzsh-4efad7ab1ba0d1715af62e484c6852808581cfb9.tar.gz
zsh-4efad7ab1ba0d1715af62e484c6852808581cfb9.tar.bz2
zsh-4efad7ab1ba0d1715af62e484c6852808581cfb9.zip
feat(git-commit): add `wip` kind (#12188)
Diffstat (limited to 'plugins/git-commit/README.md')
-rw-r--r--plugins/git-commit/README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/plugins/git-commit/README.md b/plugins/git-commit/README.md
index 91cc73b44..a00983935 100644
--- a/plugins/git-commit/README.md
+++ b/plugins/git-commit/README.md
@@ -29,8 +29,9 @@ 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>`
## Examples
@@ -38,5 +39,6 @@ Where `type` is one of the following:
| 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"` |