juandc / Emoji-Log

🚀Emoji-Log — An Emoji Git commit log messages spec standard. [ 📦👌🐛📖🚀✅ ]

EMOJI-LOG

After building hundreds of open source software I've ended up inventing a git commit log standard called EMOJI-LOG.

PHILOSOPHY

I like emoji. I like ’em a lot. Programming, code, geeks/nerds, open source, all of that is inherently dull and sometimes boring. Emoji (which is, in fact, the plural of emoji) helps me add colors and emotions to the mix. Nothing bad if you want to add emotions to this 2D flat text-based world of code. I found out that instead of memorizing hundreds of emoji it's better to keep the categories small and general.

1. IMPERATIVE ↓
   • Make your Git commit messages imperative.
   • Write commit message like you're giving an order.
   • E.g. Use ✅ Add instead of ❌ Added.
   • E.g. Use ✅ Create instead of ❌ Creating.
2. RULES ↓
   • Small number of categories — easy to memorize.
   • Nothing more nothing less.
   • E.g. 📦 NEW,👌 IMPROVE,🐛 FIX,📖 DOC,🚀 RELEASE, and ✅ TEST
3. ACTIONS ↓
   • Make git commits based on actions you take.
   • Use a good editor like VSCode to commit the right files with commit messages.

GETTING STARTED

Only use the following Git Commit Messages. Simple and small foot print is the key here.

1. 📦 NEW: IMPERATIVE_MESSAGE_GOES_HERE

   Use when you add something completely new. E.g. 📦 NEW: Add Git ignore file

2. 👌 IMPROVE: IMPERATIVE_MESSAGE_GOES_HERE

   Use when you improve/enhance piece of code like refactoring etc. E.g. 👌 IMPROVE: Remote IP API Function

3. 🐛 FIX: IMPERATIVE_MESSAGE_GOES_HERE

   Use when you fix a bug — need I say more? E.g. 🐛 FIX: Case convertor

4. 📖 DOC: IMPERATIVE_MESSAGE_GOES_HERE

   Use when you add documentation like README.md, or even inline docs. E.g. 📖 DOC: API Interface Tutorial

5. 🚀 RELEASE: IMPERATIVE_MESSAGE_GOES_HERE

   Use when you release a new version. E.g. 🚀 RELEASE: Version 2.0.0

6. ✅ TEST: IMPERATIVE_MESSAGE_GOES_HERE

   Use when you release a new version. E.g. ✅ TEST: Mock User Login/Logout

— That's it for now. Nothing more nothing less.

THE WORKFLOW

For quick prototyping, I have made the following functions that you can add to your .bashrc/.zshrc files and use Emoji-Log quickly.

#.# Better Git Logs.
### Using EMOJI-LOG (https://github.com/ahmadawais/Emoji-Log).

# Git Commit, Add all, and Push — in one step.
function gcap() {
	git add . && git commit -m "$*" && git push
}

# NEW.
function gnew() {
	gcap "📦 NEW: $@"
}

# IMPROVE.
function gimp() {
	gcap "👌 IMPROVE: $@"
}

# FIX.
function gfix() {
	gcap "🐛 FIX: $@"
}

# RELEASE.
function grlz() {
	gcap "🚀 RELEASE: $@"
}

# DOC.
function gdoc() {
	gcap "📖 DOC: $@"
}

# TEST.
function gtst() {
	gcap "✅ TEST: $@"
}

To install these functions for the fish shell, run the following commands:

function gcap; git add .; and git commit -m "$argv"; and git push; end;
function gnew; gcap "📦 NEW: $argv"; end
function gimp; gcap "👌 IMPROVE: $argv"; end;
function gfix; gcap "🐛 FIX: $argv"; end;
function grlz; gcap "🚀 RELEASE: $argv"; end;
function gdoc; gcap "📖 DOC: $argv"; end;
function gtst; gcap "✅ TEST: $argv"; end;
funcsave gcap
funcsave gnew
funcsave gimp
funcsave gfix
funcsave grlz
funcsave gdoc
funcsave gtst

USING EMOJI-LOG

Here's a list of repos that make use of Emoji-Log.

• Create-Guten-Block Toolkit →
• VSCode Shades of Purple Theme →
• Ahmad Awais GitHub Repos → — Latest repos on this account.
• CaptainCore CLI (WordPress Management Toolkit) →
• CaptainCore GUI (WordPress plugin) →
• You?! Add your repo to the list after adding the Emoji-log badge to your readme.

EMOJI-LOG BADGE COLLECTION

If your repo uses EMOJI-LOG then you can add any of the following badges to your read me and send me a PR to list your repo here.

• STYLE: Flat Square
• MARKDOWN ↓

[![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat.svg)](https://github.com/ahmadawais/Emoji-Log/)

• HTML ↓

<a href="https://github.com/ahmadawais/Emoji-Log/"><img alt="emoji-log" src="https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat.svg" /></a>

• STYLE: Flat Rounded
• MARKDOWN ↓

[![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat-round.svg)](https://github.com/ahmadawais/Emoji-Log/)

• HTML ↓

<a href="https://github.com/ahmadawais/Emoji-Log/"><img alt="emoji-log" src="https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat-round.svg" /></a>

• STYLE: Non flat Rounded
• MARKDOWN ↓

[![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/non-flat-round.svg)](https://github.com/ahmadawais/Emoji-Log/)

• HTML ↓

<a href="https://github.com/ahmadawais/Emoji-Log/"><img alt="emoji-log" src="https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/non-flat-round.svg" /></a>

SUPPORT OPEN SOURCE PROJECTS 🎩

If you'd like us to keep producing professional free and open source software (FOSS). Consider paying for an hour of my dev-time. We'll spend two hours on open source for each contribution. Yeah, that's right, you pay for one hour and get both of us to spend an hour as a thank you.

• 🚀 $99.99 — Support for one hour or more →
• 🔰 $49.99 — Support half an hour maintenance →
• ☕️ $9.99 — Buy us lunch or coffee to keep us trucking #OpenSource →

LICENSE & ATTRIBUTION

MIT © Ahmad Awais.

Thanks to Munawar for making awesome badges for this project. This FOSS (free and open source software) project is updated and maintained with the help of awesome businesses listed below. Without the support from these amazing companies/individuals, this project would not have been possible. What/How? Read more about it →

Feel free to say 👋 on Twitter @MrAhmadAwais →