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
gitg0 is a command line tool which makes lives of both project maintainers and contributors easy 😌. How does gitg0 do that❓
11
+
**Gitg0 generates commit titles (with relevant emojis) and branch names for you.** You have the ability to configure the format of the Sugggested Commit Titles and Branch Names, and change emojis according to your preference in the `.gitgo` file.
12
12
13
-
### For open-source contributors and developers 👨💻
13
+
##Usage
14
14
15
-
- Ever spent 2-3 minutes before working on thinking what to name your branch? ⸙
16
-
- After making the changes, spent time on wondering about an appropriate commit message? 🖋️
17
-
- After a long hectic day of working, skipped over the commit guidelines followed by your project? 😴
18
-
- Felt like your commit message could be a bit better if it had an emoji? ✨
15
+
Not to shout at you but **PLEASE HEAD OVER TO [USAGE.md](https://github.com/dotrachit/gitg0/blob/main/USAGE.md)**
19
16
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!**
17
+
## Installation
22
18
23
-
Head over [here](https://github.com/dotrachit/gitg0#-usage) for instructions on how to use gitg0 🎁
19
+
The tool is available as an NPM package over [here](https://www.npmjs.com/package/gitg0).
24
20
25
-
### For project maintainers 👩🔧
21
+
Before installing the package, [download and install Node.js](https://nodejs.org/en/download/).
26
22
27
-
Tired of telling contributors to follow proper commit guidelines? 😫
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 save the commit format in `.gitgo` file, and we'll suggest commits to all contributors with the same format.
30
-
31
-
Head over [here](https://github.com/dotrachit/gitg0/tree/readme#-usage) for instructions on how to do the one time gitgo setup 🎁
32
-
33
-
## 👨🏭 Who are we?
34
-
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
-
37
-
## 🔨 Installation
38
-
39
-
The tool is available as an npm package over [here](https://www.npmjs.com/package/gitg0).
40
-
41
-
Before installing the package, [download and install Node.js](https://nodejs.org/en/download/)<code><imgheight="20"src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/nodejs/nodejs.png"></code>.
42
-
Then you can install it by simple running the following command:
23
+
Then, you can install it by simple running the following command:
43
24
44
25
```bash
45
26
npm i -g gitg0
46
27
```
47
28
48
-
## 🎮 Usage
29
+
## 🎮 Commands
49
30
50
-
Currently, we have the following 7 commands which will make you **Good To Go**, `gtg`:
31
+
Currently, we have the following 7 commands:
51
32
52
33
### `gtg config`
53
34
@@ -77,16 +58,16 @@ This is a replacement for `git checkout -b` and will simply checkout with gitgo'
77
58
78
59
This is a replacement for `git commit -m` and will commit your files once added with gitgo's suggested commit message.
79
60
80
-
## 👨💻 For contributors
61
+
## Contributor guidelines
81
62
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).
63
+
- Before contributing, 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
64
- 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
65
- Continue reading the rest of the README to get the build instructions.
85
66
- For detailed information and screenshots of the project, please head over to the project [wiki](https://github.com/dotrachit/gitg0/wiki).
86
67
87
-
## 🛠️ Setting up the project
68
+
## Development setup
88
69
89
-
Before setting up the project, [download and install Node.js](https://nodejs.org/en/download/)<code><imgheight="20"src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/nodejs/nodejs.png"></code>.
70
+
Before setting up the project, [download and install Node.js](https://nodejs.org/en/download/).
90
71
91
72
After cloning the project, you need to execute the following commands to install and work on the project locally:
92
73
@@ -98,10 +79,17 @@ npm install
98
79
npm install -g ./
99
80
```
100
81
101
-
## 📜 License
82
+
## License
102
83
103
84
This project is released under a free and open-source software license, GPL-3.0 License ([LICENSE](LICENSE). The documentation is also released under a free documentation license, namely the [GFDL v1.3](https://www.gnu.org/licenses/fdl-1.3.en.html) license or later.
104
85
105
-
### 🖊️ Contributions
86
+
## Contributions
106
87
107
88
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the GPL-3.0 License, shall be licensed as above, without any additional terms or conditions.
0 commit comments