Commit Conventions Using Emojis
This guide establishes a coding style for commit messages using emojis, focusing on readability and ease of understanding. The use of emojis in commit messages is introduces a visual way to distinguish the nature of commits. This guide provides a standardized set of emojis, each representing a unique kind of git commit.
Commit Conventionsโ
Here's how you can implement this emoji commit convention:
- ๐ Bugfixes: For all bugfixes.
- ๐ Initial Commits or Project Creation: For the initial commit or project creation.
- ๐ Eye Candies and Improvements: For UI/UX improvements.
- โจ New Features: For introducing new features.
- ๐ Resolved Branch Merge Conflicts: For resolved merge conflicts.
- ๐ Documentation: For adding or updating the documentation.
- ๐งช Test Fixtures: For adding test cases.
- โ๏ธ Configuration Updates: For configuration updates.
- ๐ ๏ธ Code Refactoring: For refactoring code.
- ๐๏ธ Deletions: For deletions of files or code.
- ๐ Security Updates: For improving security.
- ๐ Internationalization (i18n) Updates: For translations or localization.
- โช Reverting Changes: For reverting back changes.
Examplesโ
Here are examples of how you can use these in your commit messages:
git commit -m "๐ Fixed missing semicolon in main.js."
git commit -m "๐ Setting up project skeleton and directory structure."
git commit -m "๐
Updated website's color scheme to match branding."
git commit -m "โจ Added social media sharing functionality."
git commit -m "๐ Resolved merge conflict in main.css due to parallel updates."
git commit -m "๐ Updated README with new feature descriptions."
git commit -m "๐งช Added unit test for the user login functionality."
git commit -m "โ๏ธ Updated webpack for better bundle optimization."
git commit -m "๐ ๏ธ Refactored main.js to remove redundant code."
git commit -m "๐๏ธ Removed deprecated loadUser function from userController.js."
git commit -m "๐ Patched potential XSS vulnerability in user profile section."
git commit -m "๐ Added French language support to the website."
git commit -m "โช Reverted back to previous commit due to breaking changes."