Topics

#alfred-snippets #emoji #emoji-log #emoji-meaning #git #vscode #workflow

Language breakdown

No language data available.

▸ Files click to expand

README

`EMOJI-LOG`

After building hundreds of open source software I've ended up inventing a git commit log standard called EMOJI-LOG that helps me understand a project's history with a less cognitive load just by looking at the git 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.

IMPERATIVE ↓

- Make your Git commit messages imperative. - Write a commit message like you're giving an order. - E.g., Use ✅ Add instead of ❌ Added. - E.g., Use ✅ Create instead of ❌ Creating.

RULES ↓

- A small number of categories — easy to memorize. - Nothing more nothing less. - E.g. 📦 NEW, 👌 IMPROVE, 🐛 FIX, 📖 DOC, 🚀 RELEASE, 🤖 TEST, and ‼️ BREAKING

ACTIONS ↓

- Make git commits based on the 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.

📦 NEW: IMPERATIVEMESSAGEGOES_HERE

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

👌 IMPROVE: IMPERATIVEMESSAGEGOES_HERE

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

🐛 FIX: IMPERATIVEMESSAGEGOES_HERE

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

📖 DOC: IMPERATIVEMESSAGEGOES_HERE

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

🚀 RELEASE: IMPERATIVEMESSAGEGOES_HERE

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

🤖 TEST: IMPERATIVEMESSAGEGOES_HERE

> Use when it's related to testing. > E.g. 🤖 TEST: Mock User Login/Logout

‼️ BREAKING: IMPERATIVEMESSAGEGOES_HERE

> Use when releasing a change that breaks previous versions. > E.g. ‼️ BREAKING: Change authentication protocol

— 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 "robot emoji" — which says some test were run successfully.
‼️ BREAKING: Emoji meaning: A "bangbang emoji" — which attracts attention to a breaking change.

VSCode Extension

If you use VSCode, then I have built an extension Emoji-Log for VSCode. This can help you write git commit messages quickly.

Bash/Zsh 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.
gcap() {
    git add . && git commit -m "$*" && git push
}
NEW.
gnew() {
    gcap "📦 NEW: $@"
}
IMPROVE.
gimp() {
    gcap "👌 IMPROVE: $@"
}
FIX.
gfix() {
    gcap "🐛 FIX: $@"
}
RELEASE.
grlz() {
    gcap "🚀 RELEASE: $@"
}
DOC.
gdoc() {
    gcap "📖 DOC: $@"
}
TEST.
gtst() {
    gcap "🤖 TEST: $@"
}
BREAKING CHANGE.
gbrk() {
    gcap "‼️ BREAKING: $@"
}
gtype() {
NORMAL='\033[0;39m'
GREEN='\033[0;32m'
echo "$GREEN gnew$NORMAL — 📦 NEW
$GREEN gimp$NORMAL — 👌 IMPROVE
$GREEN gfix$NORMAL — 🐛 FIX
$GREEN grlz$NORMAL — 🚀 RELEASE
$GREEN gdoc$NORMAL — 📖 DOC
$GREEN gtst$NORMAL — 🧪️ TEST
$GREEN gbrk$NORMAL — ‼️ BREAKING"
}

Fish Shell Workflow

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 gbrk; gcap "‼️ BREAKING: $argv"; end;
funcsave gcap
funcsave gnew
funcsave gimp
funcsave gfix
funcsave grlz
funcsave gdoc
funcsave gtst
funcsave gbrk

Git Aliases

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"   # BREAKING CHANGE.   brk = "!f() { git cap \"‼️ BREAKING: $@\"; }; f"

Using

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.

AlfredSnippets

Alfred Snippets

Alfred PowerPack users can use the Snippets feature to quickly call Emoji-Log, or use the text expand feature for even quicker creation.

To setup:

Have Alfred 3 with PowerPack installed
For auto expansion, in Alfred Settings » Features » Snippets ensure the "Automatically expand snippets by Keyword" box is checked
Download & open Emoji-Log.alfredsnippets, deselecting "Strip snippets of 'auto expand' flag" when prompted

This will give the following text expander keywords for the Emoji-Log:

| Keyword | Snippet | | ------- | ------------ | | ;gnew | 📦 NEW: | | ;gimp | 👌 IMPROVE: | | ;gfix | 🐛 FIX: | | ;grlz | 🚀 RELEASE: | | ;gdoc | 📖 DOC: | | ;gtst | 🤖 TEST: | | ;gbrk | ‼️ BREAKING: |

To edit the ; prefix to your preferred expansion flag, double click right click the Emoji-Log Collection in Alfred Settings » Features » Snippets.

TextExpander Snippets are also available. Download & open Emoji-Log.textexpander to import.

Raycast Snippets

Raycast users can use the Snippets feature to quickly expand Emoji-Log commit messages with text shortcuts.

To setup:

Download the emoji-log-raycast-snippets.json file
Open Raycast → Snippets
Select "Import Snippets"
Choose the downloaded JSON file

This will give you the following text expander keywords for Emoji-Log:

| Keyword | Snippet | | ------- | ------------ | | ;gnew | 📦 NEW: | | ;gimp | 👌 IMPROVE: | | ;gfix | 🐛 FIX: | | ;grlz | 🚀 RELEASE: | | ;gdoc | 📖 DOC: | | ;gtst | 🤖 TEST: | | ;gbrk | ‼️ BREAKING: |

Pro Tip: You can also generate the snippets file programmatically by running node generate-raycast-snippets.js in the repository root.

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.

STYLE: Flat Square
MARKDOWN ↓

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 ↓

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 ↓

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>

Sponsor

Me (Ahmad Awais) and my incredible wife (Maedah Batool) are two engineers who fell in love with open source and then with each other. You can read more about me here. If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate.