ohmyzsh/plugins/git-commit-template/README.md

[![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 
desired description and type of message. This file is prepared for use in zsh.

## Learn This Articles

- #### [How to Write Better Git Commit Messages](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/)

- #### [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

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.

![gct](images/1.png)

![result](images/2.png)

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

![git log](images/3.png)

### signature

You can use `-s` or `sign` to add a signature to the gct.

```bash
➜  gct -s
➜  gct sign
```

## Tanks For Supporting 🐯