Emoji Prefix Convention

Emoji Prefix

🌟ADD

Use when you add something entirely new. E.g. 🌟ADD: Add Git ignore file

💡IMPROVE

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

🐛FIX

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

📝NOTE

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

🚀RELEASE

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

🤖TEST

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

⚠️BREAK

Use when releasing a change that breaks previous versions. E.g. ⚠️BREAK: Change authentication protocol

Structure

[emoji prefix]: [scope] - [main idea]
[body]

Components

• subject - 50 character commit message
  • emoji prefix - summary of the changes using emoji from the list above
  • scope - [optional] the part of the system you are changing
  • main idea - TLDR, main idea of the changes in imperative tense
• body - [optional] If not obvious, providing insight into the nature of the changes, the reasoning behind them, and any significant consequences or considerations Conclude with any relevant issue references at the end of the message.

Take a deep breath and think about a 50 character commit message follow the emoji prefix.