Skip to content

Latest commit

 

History

History
294 lines (209 loc) · 9.47 KB

README.md

File metadata and controls

294 lines (209 loc) · 9.47 KB
Raw

EMOJI-LOG

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

emoji-log


Philosophy

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 wrong if you want to attach feelings 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 ↓
    • A 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.

Start

GETTING STARTED

Only use the following Git Commit Messages. A simple and small footprint is critical here.

  1. 📦 NEW: IMPERATIVE_MESSAGE_GOES_HERE

    Use when you add something entirely 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 converter

  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

  7. 💥 GIT: SOME_MESSAGE_GOES_HERE

    Use when you have some git related message. E.g. 💥 GIT: This is a merge

  8. 😅 TRY: IMPERATIVE_MESSAGE_GOES_HERE

    Use when you might break code due to that commit. E.g. 😅 TRY: I don't know what I am doing

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


More

THE WORKFLOW & MEANINGS

I'd like to share what each of these emojis mean.

  • 📦 NEW: Emoji meaning: A "package emoji" — which can contain new stuff.
  • 👌 IMPROVE: Emoji meaning: An "OK Hand emoji" — which is meant to appreciate an improvement.
  • 🐛 FIX: Emoji meaning: A "bug emoji" — which means there was a bug that got fixed.
  • 📖 DOCS: Emoji meaning: A "book emoji" — which means documentation or notes just like in a book.
  • 🚀 RELEASE: Emoji meaning: A "rocket emoji" — which is meant to show a new release/launch.
  • ✅ TEST: Emoji meaning: A "check emoji" — which says some test were written.
  • 💥 GIT: Emoji meaning: A "blast emoji" - which says the commit was git related
  • 😅 TRY: Emoji meaning: A "sweat emoji" - which is to be used when commits might break stuffs and might not even work.

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

#################
# Git Emoji-Log #
#################

# Git Add all
function gta() {
    git add .
}

# Git Commit, and Push — in one step.
function gcap() {
    git commit -m "$1" -m "$2" && 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: $@"
}

# MERGE, GIT STUFFS, CONFLICTS, COMMITS THAT DON'T HAVE TO BE COMMITED.
function ggit() {
    gcap "💥 GIT: $@"
}

# COMMITS THAT YOU ARE SURE MIGHT GO WRONG, BUT YOU STILL NEED TO COMMIT.
function gtry() {
    gcap "😅 TRY: $@"
}

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;
function ggit; gcap "💥 GIT: $argv"; end;
function gtry; gcap "😅 TRY: $argv"; end;
funcsave gcap
funcsave gnew
funcsave gimp
funcsave gfix
funcsave grlz
funcsave gdoc
funcsave gtst
funcsave ggit
funcsave gtry

If you prefer, you can paste these aliases directly in your ~/.gitconfig file:

# Make sure you're adding under the [alias] block.
[alias] 
  # Git Commit, Add all and Push — in one step.
  cap = "!f() { git add .; git commit -m \"$@\"; git push; }; f"

  # NEW.
  new = "!f() { git cap \"📦 NEW: $@\"; }; f"
  # IMPROVE.
  imp = "!f() { git cap \"👌 IMPROVE: $@\"; }; f"
  # FIX.
  fix = "!f() { git cap \"🐛 FIX: $@\"; }; f"
  # RELEASE.
  rlz = "!f() { git cap \"🚀 RELEASE: $@\"; }; f"
  # DOC.
  doc = "!f() { git cap \"📖 DOC: $@\"; }; f"
  # TEST.
  tst = "!f() { git cap \"✅ TEST: $@\"; }; f"

Using

USING EMOJI-LOG

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


badge

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.


emoji-log

  • 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>

emoji-log

  • 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>

emoji-log

  • 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>

Hello

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.


Thanks

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 excellent 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 →