Ahmad Awais

NAVIGATE


SHARE


๐Ÿš€ Emoji-Log โ€” A New Way to Write Your Git Commit Messages and Changelogs

Ahmad AwaisAhmad Awais
๐Ÿ™Œ Howdy! This piece is a part of my 2018 Year in Review (read the context) โ†’

Emoji log is a new way to write your Git Commit Messages. I like emoji. I like โ€™em a lot. Programming, code, geeks, nerds, open source, all of that is inherently dull and sometimes boring. I improve that by using Emoji.

I also am a big fan of the Don’t Repeat Yourself (DRY) philosophy and believe writing better Git commit messagesโ€”ones that are contextual enough to serve as a changelog for your open source softwareโ€”is an important component of DRY.

One of the many workflows I’ve written is Emoji-Log, a straightforward, open source Git commit log standard. It improves the developer experience (DX) by using emoji to create better Git commit messages. For more check out my article on OpenSource.com

Emoji-Log’s philosophy

Instead of memorizing hundreds of emoji, I’ve learned it’s better to keep the categories small and general. Here’s the philosophy that guides writing commit messages with Emoji-Log:

  1. IMPERATIVE: Make your Git commit messages imperative. Write commit message like you’re giving an order.
    โ€” Use โœ… Add instead of โŒ Added.
    โ€” Use โœ… Create instead of โŒ Creating.
  2. RULES: A small number of categories are easy to memorize. Nothing more, nothing less. There are only six types of Emoji log. One should only use these six types and nothing else. Which are
    โ†’ ๐Ÿ“ฆ NEW: [Git Commit Message goes here]
    โ†’ ๐Ÿ‘Œ IMPROVE: [Git Commit Message goes here]
    โ†’ ๐Ÿ› FIX: [Git Commit Message goes here]
    โ†’ ๐Ÿ“– DOC: [Git Commit Message goes here]
    โ†’ ๐Ÿš€ RELEASE: [Git Commit Message goes here]
    โ†’ โœ… TEST: [Git Commit Message goes here]
  3. ACTIONS: Make Git commits based on actions you take. Use a good editor like VSCode to commit the right files with commit messages.
๐ŸŒŸ I recommend that you check out and Star the Emoji-log repo โ†’
๐Ÿ“จ

TheDevTakeaway: Developers' Newsletter!

Takeaway my professional opinion about Open Source, JavaScript/Cloud, Full Stack Development, building a business, growing a family, and everything in between! Delivered to your inbox once a month. ๐Ÿคฃ I'm even funny some times. ๐Ÿ‘ป I hate spam! Pinky Promise!

๐Ÿ‘จโ€๐Ÿซ Edutainer & teacher at VSCode.pro ๐ŸŽฉ Full-time #OpenSourcerer ๐ŸฆŠ Google Developers Expert for Web ๐Ÿฅ‘ OSS Developer Advocate ๐ŸŒณ Node.js Foundation Community Committee Member ๐Ÿ”ฅ Ridiculously hard-working Full Stack Web Developer ๐Ÿ˜‚ Hilarious comedian โ“ฆ Regular WordPress Core Developer ๐Ÿ“ฃ TEDx Speaker โœŒ๏ธ Spends 50-80% of his time building professional FOSS (Free & Open Source Software) used by over 1,399,687 Developers ๐Ÿ™Œ Cloud Community Evangelist ๐ŸŽฏ JavaScript & DevOps fanboy ๐Ÿ’œ Loves his wife (Maedah) ๐Ÿ• Learn more about Ahmad โ†ฃ

Say ๐Ÿ‘‹ on Twitter @MrAhmadAwais | Subscribe to the Developer's Takeaway!

๐Ÿ”ฅ CHECK OUT โ†’