😎 Gitmoji

Table of Contents

• 💭 Background
• ⚡ Quickstart
• 📥 Installation
  • Linux/Mac
  • Windows
  • Self Build
• 📄 Documentation
  • First Steps
  • Modularity
• 🙌 Contributing

💭 Background

I was on the wave of emoji commit messages, but after a while, having to keep going to a website and then think about which emoji you want to use, copy it, and then paste it along with my commit message was just not worth it.

So how about I just type something like gitm fix It should be all good now where fix declares the type of emoji I want to use and "It should be all good now" is my commit message? Here, I'll help you scroll down: click me.

⚡ Quickstart

$ git add -A
$ gitm new Implemented new security features
Successfully commited: ✨ Implemented new security features

# OR

$ gitm new -a Implemented new security features
Successfully commited: ✨ Implemented new security features

📥 Installation

Linux/Mac

# Linux
$ wget https://github.com/VijayStroup/gitmoji/releases/download/v0.1.0/gitmoji-v0.1.0-linux.tar.gz
$ tar -xvf gitmoji-v0.1.0-linux.tar.gz

# Mac
$ wget https://github.com/VijayStroup/gitmoji/releases/download/v0.1.0/gitmoji-v0.1.0-mac.tar.gz
$ tar -xvf gitmoji-v0.1.0-mac.tar.gz

# both
$ chmod +x gitm && sudo mv gitm /usr/local/bin
$ gitm -v
gitm version 0.1.0

Windows

You're using WSL right? 😅
If so refer to the Linux/Mac Section.
If not, click this.

Self Build

Requirements:

• Go!
• Git global config set
  • git config --global user.email "[email protected]"
  • git config --global user.name "Your Name"

$ wget https://github.com/VijayStroup/gitmoji/archive/v0.1.0.tar.gz
$ tar -xvf v0.1.0.tar.gz && cd gitmoji-0.1.0
$ go test tests/commit_test.go
ok      command-line-arguments  3.766s
$ go build -o gitm . && sudo mv gitm /usr/local/bin
$ cd .. && rm -rf gitmoji-0.1.0 v0.1.0.tar.gz
$ gitm -v
gitm version 0.1.0

📄 Documentation

First Steps

Make sure where ever you choose to install the gitm binary, that location is in your $PATH.
The three default commands are new, update, fix with emojis ✨, ☝️, and 🔧 respectfully. These default emojis can be overwritten by extending Gitmoji. See Modularity.

Modularity

When adding a new command, or overwriting one of the three default commands, all you have to do is add a new environment variable with a prefix of GITM_.
Here is an example:

export GITM_BUILD="build:🏗️"

The suffix of the variable name is insignificant, however for every command you wish to make, it would be wise to make them all different so that they do not overwrite each other.
Notice the format of the variable: command:emoji. Gitmoji commands will always be in lowercase, even if in this case you were to set the variable above to BuiLD:🏗️. The correct way to use this command would be gitm build A fresh build.
For the emoji, any text can be represented here (it does not actually have to be an emoji), and will be prepended to your git commit message.

For lasting effect, make sure to add Gitmoji commands to your .bashrc.
Here is an example .bashrc:

export GITM_BUILD="build:🏗️"
export GITM_NEW="new:🌟"
export GITM_DELETE="del:❌"

Now the following new commands would be available: build, del and new would be overwritten from the default emoji of ✨ to 🌟.

🙌 Contributing

I'm not that quite sure on how much more you can do with just git commits but if you know something, don't hesitate to open a new Pull Request!

Only one thing though (well a few):
PRs are broken down into 3 sections: new, update, fix.

• ✨ New: Any new features or completely new logic into a pre-existing function.
• ☝️ Update: Edits to a pre-existing function or logic.
• 🔧 Fix: Fixing bug found in program (overtakes Update if Update is a fix to a bug).

When submitted PRs, please have your commit messages in the form of EMOJI MESSAGE with EMOJI being the corresponding emoji from the list above and MESSAGE being the commit message. We must set the example!