mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2025-02-13 21:11:13 +01:00
doc(README.md): update README.md
This commit is contained in:
parent
b1ee81f4f0
commit
299323aff2
1 changed files with 41 additions and 13 deletions
|
@ -1,14 +1,10 @@
|
||||||
# git-commit-template plugin
|
[](https://github.com/ghasemdev/git-commit-template/releases/tag/v1.1.0)
|
||||||
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
|
# git-commit-template
|
||||||
|
|
||||||
To better write git commit messages, we can use template to specify the
|
To better write git commit messages, we can use template to specify the
|
||||||
desired description and type of message.
|
desired description and type of message. This file is prepared for use in zsh.
|
||||||
|
|
||||||
To use it, add `git-commit-template` to the plugins array in your zshrc
|
|
||||||
file:
|
|
||||||
|
|
||||||
```zsh
|
|
||||||
plugins=(... git-commit-template)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Learn This Articles
|
## Learn This Articles
|
||||||
|
|
||||||
|
@ -16,17 +12,49 @@ plugins=(... git-commit-template)
|
||||||
|
|
||||||
- #### [Epower Git Template](https://github.com/epowerng/git-template)
|
- #### [Epower Git Template](https://github.com/epowerng/git-template)
|
||||||
|
|
||||||
|
- #### [چگونه یک پیغام گیت با معنا بنویسیم؟](https://virgool.io/@mmdsharifi/how-to-semantic-git-commit-messages-gvmmqatf6acg)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
In the first step, in the home directory (zshrc directory) clone git-commit-template.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
➜ ~ git clone https://github.com/ghasemdev/git-commit-template.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Then we have to run this command to install.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
➜ ~ chmod +x git-commit-template/installer.sh
|
||||||
|
➜ ~ git-commit-template/installer.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
In the last command we refresh oh-my-zsh source.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
➜ ~ source ~/.zshrc
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
All you have to do is call the `gct` command and fill in the items that
|
All you have to do is call the `gct` command and fill in the items that
|
||||||
are not optional at each step to prepare the message format.
|
are not optional at each step to prepare the message format.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
With the `git log` command, we can see the message that we committed.
|
With the `git log` command, we can see the message that we committed.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Tanks For Supporting [📌 Source](https://github.com/ghasemdev/git-commit-template)
|
### signature
|
||||||
|
|
||||||
|
You can use `-s` or `sign` to add a signature to the gct.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
➜ gct -s
|
||||||
|
➜ gct sign
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tanks For Supporting 🐯
|
||||||
|
|
Loading…
Add table
Reference in a new issue