From 30a451b2134d4c2e6af6dca10fe452afb1a7d280 Mon Sep 17 00:00:00 2001 From: Ghasem Shirdel Date: Sun, 23 Jan 2022 10:23:54 +0330 Subject: [PATCH] doc(README.md): update README.md --- plugins/git-commit-template/README.md | 43 +++++++-------------------- 1 file changed, 11 insertions(+), 32 deletions(-) diff --git a/plugins/git-commit-template/README.md b/plugins/git-commit-template/README.md index 43b3a6aa2..a3ea263f7 100644 --- a/plugins/git-commit-template/README.md +++ b/plugins/git-commit-template/README.md @@ -1,10 +1,12 @@ -[![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 plugin -# git-commit-template +To better write git commit messages, we can use template to specify the desired description and type of message. -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. +To use it, add `git-commit-template` to the plugins array in your zshrc file: + +```bash +plugins=(... git-commit-template) +``` ## Learn This Articles @@ -12,41 +14,18 @@ desired description and type of message. This file is prepared for use in zsh. - #### [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) +![gct](https://raw.githubusercontent.com/ghasemdev/git-commit-template/master/images/1.png) -![result](images/2.png) +![result](https://raw.githubusercontent.com/ghasemdev/git-commit-template/master/images/2.png) With the `git log` command, we can see the message that we committed. -![git log](images/3.png) +![git log](https://raw.githubusercontent.com/ghasemdev/git-commit-template/master/images/3.png) ### signature @@ -57,4 +36,4 @@ You can use `-s` or `sign` to add a signature to the gct. ➜ gct sign ``` -## Tanks For Supporting 🐯 +## Tanks For Supporting 📌 [Source](https://github.com/ghasemdev/git-commit-template)