Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ahmadawais/Emoji-Log

Emoji-Log โ€” An Emoji Git commit log messages spec. [ ๐Ÿ“ฆ๐Ÿ‘Œ๐Ÿ›๐Ÿ“–๐Ÿš€๐Ÿค– โ€ผ๏ธ]
https://github.com/ahmadawais/Emoji-Log

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

Last synced: about 2 months ago
JSON representation

Emoji-Log โ€” An Emoji Git commit log messages spec. [ ๐Ÿ“ฆ๐Ÿ‘Œ๐Ÿ›๐Ÿ“–๐Ÿš€๐Ÿค– โ€ผ๏ธ]

Awesome Lists containing this project

README

        


`EMOJI-LOG`

After building [hundreds of open source software](https://github.com/ahmadawais) 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](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/non-flat-round.svg)](./../../)


![Philosophy](https://user-images.githubusercontent.com/960133/120058283-3ea18480-c063-11eb-8a62-8146227093fa.png)

### 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](https://gitmoji.carloscuesta.me/) 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`.
1. **RULES** โ†“
- A small number of categories โ€” easy to memorize.
- Nothing more nothing less.
- E.g. `๐Ÿ“ฆ NEW`, `๐Ÿ‘Œ IMPROVE`, `๐Ÿ› FIX`, `๐Ÿ“– DOC`, `๐Ÿš€ RELEASE`, `๐Ÿค– TEST`, and `โ€ผ๏ธ BREAKING`
1. **ACTIONS** โ†“
- Make git commits based on the actions you take.
- Use a good editor like [VSCode](https://code.visualstudio.com/) to commit the right files with commit messages.


![Start](https://user-images.githubusercontent.com/960133/120058297-4c570a00-c063-11eb-8458-0f61cf621169.png)

### 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`

1. `๐Ÿ‘Œ IMPROVE: IMPERATIVE_MESSAGE_GOES_HERE`
> Use when you improve/enhance piece of code like refactoring etc.
> E.g. `๐Ÿ‘Œ IMPROVE: Remote IP API Function`

1. `๐Ÿ› FIX: IMPERATIVE_MESSAGE_GOES_HERE`
> Use when you fix a bug โ€” need I say more?
> E.g. `๐Ÿ› FIX: Case conversion`

1. `๐Ÿ“– DOC: IMPERATIVE_MESSAGE_GOES_HERE`
> Use when you add documentation like `README.md`, or even inline docs.
> E.g. `๐Ÿ“– DOC: API Interface Tutorial`

1. `๐Ÿš€ RELEASE: IMPERATIVE_MESSAGE_GOES_HERE`
> Use when you release a new version.
> E.g. `๐Ÿš€ RELEASE: Version 2.0.0`

1. `๐Ÿค– TEST: IMPERATIVE_MESSAGE_GOES_HERE`
> Use when it's related to testing.
> E.g. `๐Ÿค– TEST: Mock User Login/Logout`

1. `โ€ผ๏ธ 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](https://user-images.githubusercontent.com/960133/120058303-5547db80-c063-11eb-87ae-17f758a4e43b.png)

#### 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](https://marketplace.visualstudio.com/items?itemName=ahmadawais.emoji-log-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.

```sh
#.# 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:

```sh
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:

```sh
# 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](https://user-images.githubusercontent.com/960133/120058311-61339d80-c063-11eb-9853-da0905b7c288.png)

### USING `EMOJI-LOG`

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

- [Create-Guten-Block Toolkit โ†’](https://github.com/ahmadawais/create-guten-block/commits/)
- [VSCode Shades of Purple Theme โ†’](https://github.com/ahmadawais/shades-of-purple-vscode/commits/)
- [Ahmad Awais GitHub Repos โ†’](https://github.com/ahmadawais) โ€” _Latest repos on this account._
- [CaptainCore CLI (WordPress Management Toolkit) โ†’](https://github.com/CaptainCore/captaincore-cli/commits/)
- [CaptainCore GUI (WordPress plugin) โ†’](https://github.com/CaptainCore/captaincore-gui/commits/)
- **You?!** Add your repo to the list after adding the Emoji-log badge to your readme.


![AlfredSnippets](https://user-images.githubusercontent.com/960133/120058316-685aab80-c063-11eb-8bfd-cb0d4b3e34c2.png)

### Alfred Snippets

[Alfred](https://www.alfredapp.com/) [PowerPack](https://www.alfredapp.com/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`](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`](Emoji-Log.textexpander) to import.


![badge](https://user-images.githubusercontent.com/960133/120058320-6ee92300-c063-11eb-834c-20463fdfb0dd.png)

### `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](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat.svg)

- **STYLE**: Flat Square
- **MARKDOWN** โ†“

```markdown
[![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat.svg)](https://github.com/ahmadawais/Emoji-Log/)
```

- **HTML** โ†“

```html
emoji-log
```


![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat-round.svg)

- **STYLE**: Flat Rounded
- **MARKDOWN** โ†“

```markdown
[![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat-round.svg)](https://github.com/ahmadawais/Emoji-Log/)
```

- **HTML** โ†“

```html
emoji-log
```


![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/non-flat-round.svg)

- **STYLE**: Non-flat Rounded
- **MARKDOWN** โ†“

```markdown
[![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/non-flat-round.svg)](https://github.com/ahmadawais/Emoji-Log/)
```

- **HTML** โ†“

```html
emoji-log
```


[![๐Ÿ‘Œ](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/sponsor.png)](./../../)

## Sponsor

Me ([Ahmad Awais](https://twitter.com/mrahmadawais/)) and my incredible wife ([Maedah Batool](https://twitter.com/MaedahBatool/)) are two engineers who fell in love with open source and then with each other. You can read more [about me here](https://ahmadawais.com/about). 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.

- ๐ŸŒŸ **$9.99/month (recommended)** โฏ [Two cups of Caffรจ latte (coffee) every month โ†’](https://pay.paddle.com/checkout/540217)
- ๐Ÿš€ **$99.99 (one-time sponsor)** โฏ [Support an hour of open-source code โ†’](https://pay.paddle.com/checkout/515568)
- ๐Ÿ”ฐ **$49.99 (one-time sponsor)** โฏ [Support an hour of maintenance โ†’](https://pay.paddle.com/checkout/527253)
- โ˜•๏ธ **$9.99 (one-time sponsor)** โฏ [Lunch/coffee โ†’](https://pay.paddle.com/checkout/527254)


[![๐Ÿ“ƒ](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/license.png)](./../../)

## License & Conduct

- MIT ยฉ [Ahmad Awais](https://twitter.com/MrAhmadAwais/)
- [Code of Conduct](code-of-conduct.md)
- [Munawar](https://munwr.com/) for making awesome badges


[![๐Ÿ™Œ](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/connect.png)](./../../)

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