Merge remote-tracking branch 'github/master'HEADmaster

1 files changed, 42 insertions, 0 deletions

diff --git a/plugins/git-commit/README.md b/plugins/git-commit/README.md
new file mode 100644
index 000000000..91cc73b44
--- /dev/null
+++ b/plugins/git-commit/README.md
@@ -0,0 +1,42 @@
+# 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.
+
+To use it, add `git-commit` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... git-commit)
+```
+
+## Syntax
+
+```zsh
+git <type> [(-s, --scope) "<scope>"] "<message>"
+```
+
+> ⚠️ Single/Double quotes around the scope and message are required
+
+Where `type` is one of the following:
+
+- `build`
+- `chore`
+- `ci`
+- `docs`
+- `feat`
+- `fix`
+- `perf`
+- `refactor`
+- `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 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"`           |