Home

Awesome

Git Commit Emojis

Image Image Image Image Image Image

Image

A simple cross platform python script that automates easy labelling of git commits with descriptive emojis and text. Issues, PRs and suggestions more than welcome.

About

We all like a bit of extra color and spice to our boring old commit messages, this not only adds that but also adds information about the commit.

Installation

Planning on putting the project on pypi and scoop soon

Simple

# <commit> = name you wish to give the command (I recommend gc or commit)
git clone https://github.com/TechWiz-3/git-commit-emojis.git ~/git-commit-emojis
cp ~/git-commit-emojis/commit /usr/local/bin/<commit>
chmod +x /usr/local/bin/<commit>

Path

git clone https://github.com/TechWiz-3/git-commit-emojis.git
chmod +x commit gc

Then go into your ~/.bash_profile and add the line export PATH=${PATH}:/driveorhome/ur_username/Desktop/filepath/git-commit-emojis

Usage

The Story

So I noticed that this programmer's commits always had really neat looking labels with emojis. I searched it up and found a number of repositories or gists talking about emojis for various sorts of commits.
My favourite was emoji log (which msaaddev uses). Not only does it add emojis but it includes simple labels that go with the emojis. However, emoji log only allows 5 labels, no more, and for each label a custom command is made.
While this is an elegant solution, what if you want more than just 5 labels?

This project combines the stablity of emojified commit labels (emoji-log), with an increased diversity of emojis and labels (gitmoji) while requiring no memorisation and keeping the CLI interface compact and neat.

Here are the emoji guides mentioned above, they are all great and this project wouldn't be possible without them so be sure to check them out:

Label Guide

Select Menu Options

Usage:

commit -m "your commit message (with or without quotes)"

Image
👌 Improvement = 👌 IMPROVE: <commit message>
📦 Addition = 📦 NEW: <commit message>
📖 Documentation = 📖 DOC: <commit message>
🐛 Bug-fix = 🐛 FIX: <commit message>
🔖 Version-tag = 🔖 <commit message>

Shorcut Options:

Usage:

commit -sh <shortcut>

Shortcuts:

ty commit message defaults to: ✏️ FIX TYPO

cl commit message defaults to: 🧹 CLEAN UP

in commit message defaults to: 🎉 INITIAL COMMIT

ln commit message defaults to 🚨 FIX LINT WARNINGS

Other menus

Emoji-log menu

commit -s "msg" or commit --strict "msg"

Image
👌 Improvement = 👌 IMPROVE: <commit message>
📦 Addition = 📦 NEW: <commit message>
📖 Documentation = 📖 DOC: <commit message>
🐛 Bug-fix = 🐛 FIX: <commit message>
🚀 Release = 🚀 RELEASE: <commit message>
🤖 Test = 🤖 TEST: <commit message>
‼️ Breaking = ‼️ BREAKING: <commit message>

Extra menu

commit -e "msg" or commit --extra "msg"

Image
🔧 Config files = 🔧 CONFIG: <commit message>
🚚 Move files = 🚚 MOVE: <commit message>
🙈 Ignore files = 🙈 IGNORE: <commit message>
❌ Remove files = ❌ REMOVE: <commit message>

Support the project

You can support the project by adding the following text to the end of your README.md

---
### 🎉 Commit labels
If you're interested in the commit labels used in this repo, check out the [git commit emoji](https://github.com/TechWiz-3/git-commit-emojis) project