linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-26 21:51:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc(README.md): update README.md

Browse source
This commit is contained in:
Ghasem Shirdel 2022-01-23 10:13:57 +03:30 committed by GitHub
parent b1ee81f4f0
commit 299323aff2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
plugins/git-commit-template/README.md
View file

@ -1,14 +1,10 @@
# git-commit-template plugin [![Version](https://shields.io/badge/VERSION-1.2.0-blue?style=for-the-badge)](https://github.com/ghasemdev/git-commit-template/releases/tag/v1.1.0)
[![License Apache-2.0](https://shields.io/badge/LICENSE-APACHE--2.0-orange?style=for-the-badge)](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.
![gct](https://raw.githubusercontent.com/ghasemdev/git-commit-template/master/images/1.png) ![gct](images/1.png)
![result](https://raw.githubusercontent.com/ghasemdev/git-commit-template/master/images/2.png) ![result](images/2.png)
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.
![git log](https://raw.githubusercontent.com/ghasemdev/git-commit-template/master/images/3.png) ![git log](images/3.png)
### 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 🐯