Skip to content

Commit 5c482a8

Browse files
committed
docs(README.md): update documentation
1 parent ceb4e0a commit 5c482a8

1 file changed

Lines changed: 44 additions & 1 deletion

File tree

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,45 @@
11
# git-commit-template
2-
To better write git commit messages, we can use a ready-made template to specify the desired description and type of message. This file is prepared for use in zsh.
2+
3+
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.
4+
5+
## Learn This Articles
6+
7+
- #### [How to Write Better Git Commit Messages](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/)
8+
9+
- #### [Epower Git Template](https://github.com/epowerng/git-template)
10+
11+
- #### [چگونه یک پیغام گیت با معنا بنویسیم؟](https://virgool.io/@mmdsharifi/how-to-semantic-git-commit-messages-gvmmqatf6acg)
12+
13+
## Installation
14+
15+
In the first step, in the home directory (zshrc directory) clone git-commit-template.
16+
17+
```bash
18+
~ git clone https://github.com/amueller/word_cloud.git
19+
```
20+
21+
Then we have to run this command to install.
22+
23+
```bash
24+
~ chmod +x git-commit-template/installer.sh
25+
~ git-commit-template/installer.sh
26+
```
27+
28+
In the last command we refresh oh-my-zsh source.
29+
30+
```bash
31+
~ source ~/.zshrc
32+
```
33+
34+
## Usage
35+
36+
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.
37+
38+
![gct](images/1.png)
39+
![result](images/2.png)
40+
41+
With the `git log` command, we can see the message that we committed.
42+
43+
![git log](images/3.png)
44+
45+
## Tanks For Supporting 🐯

0 commit comments

Comments
 (0)