Customization/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-18 10:22:00 +00:00
Code Releases Activity

docs(git-commit): add warning

Browse source
This commit is contained in:
Carlo Sala 2024-03-02 10:05:54 +01:00
parent b6c1de87b0
commit 458fc2e1df
No known key found for this signature in database
GPG key ID: DA6FB450C1A4FE9A
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
plugins/git-commit/README.md
View file

@ -1,6 +1,8 @@
# git-commit plugin # 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: 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>" 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: Where `type` is one of the following:
- `build` - `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. > 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>` > 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 ## Examples
| Git alias | Command | | Git alias | Command |