gitg0 is a command line tool which makes lives of both project maintainers and contributors easy 😌. How does gitg0 do that❓

• Ever spent 2-3 minutes before working on thinking what to name your branch? ⸙
• After making the changes, spent time on wondering about an appropriate commit message? 🖋️
• After a long hectic day of working, skipped over the commit guidelines followed by your project? 😴
• Felt like your commit message could be a bit better if it had an emoji? ✨

Well, gitg0 takes care of all this and much more! 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!

Head over here for instructions on how to use gitg0 🎁

Tired of telling contributors to follow proper commit guidelines? 😫

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.

Head over here for instructions on how to do the one time gitgo setup 🎁

This project was built by Preet Shah, Shambhavi Aggarwal, Rachit Gupta and Yash Khare.

The tool is available as an npm package over here.

Before installing the package, download and install Node.js. Then you can install it by simple running the following command:

npm i -g gitg0

Currently, we have the following 7 commands which will make you Good To Go, gtg:

Use this to set up your project's gitgo configuration. You will be asked certain questions regarding your commit and emoji preferences.

Use this to check the version of your installed gitg0 package.

Use this to get the list of commands along with their functions.

Use this before you you start working on a new issue so that we can suggest the branch names and commit messages automatically.

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.

This is a replacement for git checkout -b and will simply checkout with gitgo's suggested branch name.

This is a replacement for git commit -m and will commit your files once added with gitgo's suggested commit message.

• Before contributing do go through the Code of Conduct and the Contributor Guidelines.
• If you find any bugs in the application, or a feature you think would be nice to have, please open an issue.
• Continue reading the rest of the README to get the build instructions.
• For detailed information and screenshots of the project, please head over to the project wiki.

Before setting up the project, download and install Node.js.

After cloning the project, you need to execute the following commands to install and work on the project locally:

# This will install all the needed dependencies
npm install

# This will install the project from source locally in your system
npm install -g ./

This project is released under a free and open-source software license, GPL-3.0 License (LICENSE. The documentation is also released under a free documentation license, namely the GFDL v1.3 license or later.

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.