Emoji Log by Ahmad Awais

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.

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.
RULES ↓
- Small number of categories — easy to memorize.
- Nothing more nothing less.
- E.g. 📦 NEW,👌 IMPROVE,🐛 FIX,📖 DOC,🚀 RELEASE, and ✅ TEST
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.

📦 NEW: IMPERITIVE_MESSAGE_GOES_HERE

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

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

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

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

Use when you release a new version. E.g. 🚀 RELEASE: Version 2.0.0
✅ TEST: IMPERITIVE_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.

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: $@"
}

USING `EMOJI-LOG`!

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

Create-Guten-Block
AhmadAwais — Latest repos on this account.
You?! Add your repo to the list after adding the Emoji-log badge to your readme.

`EMOJI-LOG` BADGE!

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.

Flat Square
- Markdown: ![emoji-log-badge-flat-square](https://raw.githubusercontent.com/ahmadawais/Emoji-Log/master/badges/emoji-log-badge-flat-round.png)
- HTML: <img alt="emoji-log-badge-flat-square" src="https://raw.githubusercontent.com/ahmadawais/Emoji-Log/master/badges/emoji-log-badge-flat-round.png" />
Non-flat Round
- Markdown: ![emoji-log-badge-flat-round](https://raw.githubusercontent.com/ahmadawais/Emoji-Log/master/badges/emoji-log-badge-flat-square.png)
- HTML: <img alt="emoji-log-badge-flat-round" src="https://raw.githubusercontent.com/ahmadawais/Emoji-Log/master/badges/emoji-log-badge-flat-square.png" />

Are you a designer?! This project could use better badges, kindly contribute.

laskoviymishka/Emoji-Log