fengkiej / commit-message-emoji

Every commit is important. So let's celebrate each and every commit with a corresponding emoji! :smile:

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Commit Message Emoji πŸ‘‹

Every commit is important. So let's celebrate each and every commit with a corresponding emoji! πŸ˜„

Oh, and it can also help with glancing over commit messages to figure out what kind of changes have been made. 😏

Usage

Prepend every commit message with an emoji with this form: <emoji> commit message.

For commits with multiple types of messages, use multiple lines:

<emoji> commit message
<emoji2> commit message2

Which Emoji to Use? ❓

Commit Type Emoji
Initial Commit πŸŽ‰ Party Popper
Version Tag πŸ”– Bookmark
New Feature ✨ Sparkles
Bugfix πŸ› Bug
Security Fix πŸ”’ Lock
Metadata πŸ“‡ Card Index
Refactoring ♻️ Black Universal Recycling Symbol
Documentation πŸ“š Books
Internationalization 🌐 Globe With Meridians
Accessibility β™Ώ Wheelchair
Performance 🐎 Horse
Cosmetic 🎨 Artist Palette
Tooling πŸ”§ Wrench
Tests 🚨 Police Cars Revolving Light
Deprecation πŸ’© Pile of Poo
Removal πŸ—‘οΈ Wastebasket
Work In Progress (WIP) 🚧 Construction Sign

Using Emoji is Hard! 😑

Here are some ways to more easily integrate emoji into your workflow.

Comparison

You can be the judge on which is easier to grok.

Example taken from here

Commits Without Emoji 😧

0.5.2

Fix exporting of the library to include _.ifElse

0.5.1

add _.ifElse to README.md

0.5.0

add _.ifElse

fix JSDoc comment for _.call

Fix _.not documentation example.

Update JSDoc comments.

0.4.1

Update links to documentation.

Fix documentation.

Link to documentation pages.

0.4.0

Added a curried version of the mixin for lodash-fp.

Switch from lodash to lodash-compat

Add shields to README.

Add missing methods to index.js.

Commits with Emoji πŸ˜ƒ

πŸ”– 0.5.2

πŸ› Fix exporting of the library to include _.ifElse

πŸ”– 0.5.1

πŸ“š add _.ifElse to README.md

πŸ”– 0.5.0

✨ add _.ifElse

πŸ“š fix JSDoc comment for _.call

πŸ“š Fix _.not documentation example.

πŸ“š Update JSDoc comments.

πŸ”– 0.4.1

πŸ“š Update links to documentation.

πŸ“š Fix documentation.

πŸ“š Link to documentation pages.

πŸ”– 0.4.0

✨ Added a curried version of the mixin for lodash-fp.

πŸ“‡ Switch from lodash to lodash-compat

πŸ“‡ Add shields to README.

πŸ› Add missing methods to index.js.

About

Every commit is important. So let's celebrate each and every commit with a corresponding emoji! :smile:

License:MIT License