Emoji-Log

by ahmadawais

ahmadawais /Emoji-Log

Emoji-Log β€” An Emoji Git commit log messages spec standard. [ πŸ“¦πŸ‘ŒπŸ›πŸ“–πŸš€πŸ€– ‼️]

506 Stars 49 Forks Last release: about 2 years ago (0.7.0) MIT License 117 Commits 11 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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.

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 a 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
      ,
      πŸ€– TEST
      , and
      ‼️ BREAKING
  3. 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.

  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 conversion
  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 it's related to testing. E.g.

    πŸ€– TEST: Mock User Login/Logout
  7. ‼️ BREAKING: IMPERATIVE_MESSAGE_GOES_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.

function gcap() { git add . && git commit -m "$*" && git push }

NEW.

function gnew() { gcap "πŸ“¦ NEW: [email protected]" }

IMPROVE.

function gimp() { gcap "πŸ‘Œ IMPROVE: [email protected]" }

FIX.

function gfix() { gcap "πŸ› FIX: [email protected]" }

RELEASE.

function grlz() { gcap "πŸš€ RELEASE: [email protected]" }

DOC.

function gdoc() { gcap "πŸ“– DOC: [email protected]" }

TEST.

function gtst() { gcap "πŸ€– TEST: [email protected]" }

BREAKING CHANGE.

function gbrk() { gcap "‼️ BREAKING: [email protected]" }

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 \"[email protected]\"; git push; }; f"

NEW.

new = "!f() { git cap "πŸ“¦ NEW: [email protected]"; }; f"

IMPROVE.

imp = "!f() { git cap "πŸ‘Œ IMPROVE: [email protected]"; }; f"

FIX.

fix = "!f() { git cap "πŸ› FIX: [email protected]"; }; f"

RELEASE.

rlz = "!f() { git cap "πŸš€ RELEASE: [email protected]"; }; f"

DOC.

doc = "!f() { git cap "πŸ“– DOC: [email protected]"; }; f"

TEST.

tst = "!f() { git cap "πŸ€– TEST: [email protected]"; }; f"

BREAKING CHANGE.

brk = "!f() { git cap "‼️ BREAKING: [email protected]"; }; f"


Using

USING
EMOJI-LOG

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


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:

  1. Have Alfred 3 with PowerPack installed
  2. For auto expansion, in Alfred Settings Β» Features Β» Snippets ensure the "Automatically expand snippets by Keyword" box is checked
  3. 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.


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 ↓
emoji-log


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 ↓
emoji-log


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 ↓
emoji-log


πŸ‘Œ

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.


πŸ“ƒ

License & Conduct


πŸ™Œ

Connect

GitHub @AhmadAwais (follow) To stay up to date on free & open-source software

Twitter @MrAhmadAwais (follow) To get #OneDevMinute daily hot tips & trolls

YouTube AhmadAwais (subscribe) To tech talks & #OneDevMinute videos

Blog: AhmadAwais.com (read) In-depth & long form technical articles

LinkedIn @MrAhmadAwais (connect) On the LinkedIn profile y'all


We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.