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. 😏

These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Usage

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

Git Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally
• When only changing documentation, include [ci skip] in the commit description

Which Emoji to Use? 😕

Consider starting the commit message with an applicable emoji:

Commit Type	Emoji
Initial Commit	🎉 :tada:
Version Tag	🔖 :bookmark:
Deployment	🚀 :rocket:
Release	:shipit:
New Feature	✨ :sparkles:
Metadata	📇 :card_index:
Refactoring	📦 :package:
Documentation	📚 :books:
Writing docs	📝 :memo:
Cosmetic	💄 :lipstick:
Tooling	🔧 :wrench:
Deprecation	💩 :poop:
Work In Progress (WIP)	🚧 :construction:
Bugfix	🐛 :bug:
Fixing something on Linux	🐧 :penguin:
Fixing something on macOS	🍎 :apple:
Fixing something on Windows	🏁 :checkered_flag:
Improving the format/structure of the code	🎨 :art:
Improving performance	🐎 :racehorse:
Plugging memory leaks	🚱 :non-potable_water:
Removing code or files	🔥 :fire:
Tests	🚨 :rotating_light:
Adding tests	✅ :white_check_mark:
Fixing the CI build	💚 :green_heart:
Dealing with security	🔒 :lock:
Upgrading dependencies	⬆️ :arrow_up:
Downgrading dependencies	⬇️ :arrow_down:
Removing linter warnings	👕 :shirt:
Translation	🌐 :globe_with_meridians:
Other	Be creative

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 And from guidelines for contributing to Atom

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.