You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-23Lines changed: 19 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,34 +10,30 @@
10
10
11
11
gitg0 is a command line tool which makes lives of both project maintainers and contributors easy 😌. How does gitg0 do that❓
12
12
13
-
### For contributors and developers 👨💻
13
+
### For open-source contributors and developers 👨💻
14
14
15
15
- Ever spent 2-3 minutes before working on thinking what to name your branch? ⸙
16
16
- After making the changes, spent time on wondering about an appropriate commit message? 🖋️
17
17
- After a long hectic day of working, skipped over the commit guidelines followed by your project? 😴
18
18
- Felt like your commit message could be a bit better if it had an emoji? ✨
19
19
20
20
Well, gitg0 takes care of all this and much more!
21
-
You just need to enter the number of the issue you're working on, and select what kind of issue it is, whether a new feature, ui refactors, documentation, security fixes, etc. gitg0 will do the rest for you. The tool will automatically suggest a branch name, and a commit message as well along with an appropriate emoji if you want one!
21
+
You just need to enter the number of the issue you're working on, and select what kind of issue it is, whether a new feature, ui refactors, documentation, security fixes, etc. gitg0 will do the rest for you. **The tool will automatically suggest a branch name, and a commit message as well along with an appropriate emoji if you want one!**
22
22
23
-
Head over [here](https://github.com/dotrachit/gitg0/tree/readme#-usage) for instructions on how to use gitg0 🎁
23
+
Head over [here](https://github.com/dotrachit/gitg0#-usage) for instructions on how to use gitg0 🎁
24
24
25
-
### For maintainers 👩🔧
25
+
### For project maintainers 👩🔧
26
26
27
27
Tired of telling contributors to follow proper commit guidelines? 😫
28
28
29
-
Fear no more, gitg0 is here! With gitg0, you can setup a `.gitgo` file and choose exactly what commit guidelines your project follows. You want an emoji? We got you covered. You want to enter a custom set of guidelines? We provide an option for that as well. Just eenter the format in which you want your commits to be, and that is the format in which the commit message that will be shown to contributors when they want to make a commit.
29
+
Fear no more, gitg0 is here! With gitg0, you can setup a `.gitgo` file and choose exactly what commit guidelines your project follows. You want an emoji? We got you covered. You want to enter a custom set of guidelines? We provide an option for that as well. Just save the commit format in `.gitgo` file, and we'll suggest commits to all contributors with the same format.
30
30
31
31
Head over [here](https://github.com/dotrachit/gitg0/tree/readme#-usage) for instructions on how to do the one time gitgo setup 🎁
32
32
33
33
## 👨🏭 Who are we?
34
34
35
35
This project was built by [Preet Shah](https://github.com/shahpreetk), [Shambhavi Aggarwal](https://github.com/agg-shambhavi), [Rachit Gupta](https://github.com/dotrachit) and [Yash Khare](https://github.com/yashk2000).
36
36
37
-
## 💻 What did we use?
38
-
39
-
gitg0 has been developed completely in javascript <code><imgheight="20"src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/javascript/javascript.png"></code>.
40
-
41
37
## 🔨 Installation
42
38
43
39
The tool is available as an npm package over [here](https://www.npmjs.com/package/gitg0).
@@ -53,40 +49,40 @@ npm i -g gitg0
53
49
54
50
Currently, we have the following 7 commands which will make you **Good To Go**, `gtg`:
55
51
56
-
### `gtg version`
52
+
### `gtg config`
57
53
58
-
It displays the version of your install gitg0 package.
54
+
Use this to set up your project's gitgo configuration. You will be asked certain questions regarding your commit and emoji preferences.
59
55
60
-
### `gtg whoami`
56
+
### `gtg version`
61
57
62
-
As the name suggests this command will help you know what the tool does and how to use the commands right from your terminal.
58
+
Use this to check the version of your installed gitg0 package.
63
59
64
-
### `gtg config`
60
+
### `gtg whoami`
65
61
66
-
This commands should be used on for the first time, while setting up the gitgo configuration. You will be asked a small set of questions regarding your commit and emoji preferences. If you would like to change these preferences sometime in future, you can run this command again to make the changes.
62
+
Use this to get the list of commands along with their functions.
67
63
68
64
### `gtg start`
69
65
70
-
Everytime you start working on a new issue, just run this command in order for the tool to know which issue you're working on. After this, the tool will suggest the branch names and commit messages automatically.
66
+
Use this before you you start working on a new issue so that we can suggest the branch names and commit messages automatically.
71
67
72
68
### `gtg display`
73
69
74
-
This command can be used to display the branch name and commit that the tool will be suggesting for a particular issue once `gtg start` has been run.
70
+
Use this to view the suggested branch name and commit title. You can also edit the suggested text based on your preference. This command should be run after `gtg start`.
75
71
76
72
### `gtg checkout`
77
73
78
-
This is a replacement for `git checkout` and will simply checkout with the suggested branch name.
74
+
This is a replacement for `git checkout -b` and will simply checkout with gitgo's suggested branch name.
79
75
80
76
### `gtg commit`
81
77
82
-
This is a replacement for `git commit` and will commit your files once added with the suggested commit message.
78
+
This is a replacement for `git commit -m` and will commit your files once added with gitgo's suggested commit message.
83
79
84
80
## 👨💻 For contributors
85
81
86
-
- Before contributing do go through the [Code of Conduct](https://github.com/dotrachit/gitg0/blob/main/CODE_OF_CONDUCT.md) and the [Contributor Guidelines](https://github.com/dotrachit/gitg0/blob/main/CONTRIBUTING.md). 🔧
87
-
- If you find any bugs in the application, or a feature you think would be nice to have, please open an [issue](https://github.com/dotrachit/gitg0/issues/new/choose). 🐞
88
-
- Continue reading the rest of the README to get the build instructions. ⛏️
89
-
- For detailed information and screenshots of the project, please head over to the project [wiki](https://github.com/dotrachit/gitg0/wiki). 📚
82
+
- Before contributing do go through the [Code of Conduct](https://github.com/dotrachit/gitg0/blob/main/CODE_OF_CONDUCT.md) and the [Contributor Guidelines](https://github.com/dotrachit/gitg0/blob/main/CONTRIBUTING.md).
83
+
- If you find any bugs in the application, or a feature you think would be nice to have, please open an [issue](https://github.com/dotrachit/gitg0/issues/new/choose).
84
+
- Continue reading the rest of the README to get the build instructions.
85
+
- For detailed information and screenshots of the project, please head over to the project [wiki](https://github.com/dotrachit/gitg0/wiki).
0 commit comments