This is an attempt to standardize the format of commit messages, for the sake of uniformity in git log, best practices for writing commit messages & fun!
Using emojis at the beginning of commit messages, other than being fun, provides a simple way to indicate the intention of that commit, an ease for the eyes when browsing/reviewing git log. It's also a simple measure of the fact that how much that commit is focused on a single purpose, which is a good practice.
If these rules and/or using emojis is an overkill for your productivity or simply losing its purposes, please tailor them to your needs or don't use them.
<type>(<scope>): <subject> <body> <footer>
<type>to identify what type of changes introduced in this commit; Allowed
<scope>to identify which component this
<type>is related to; Example
<scope>can also be empty (e.g. if the change is a global or difficult to assign to a single component), in which case the parentheses are omitted.
Ref T27, T56or
Closes #27, #56.
Resolveswill mark them as closed automatically! For more information about automatic issue closing using ketwords see their documentation(linked above).
:emoji:) is counted as one character!.
|Emoji||Raw Emoji Code||Description|
||when improving the format/structure of the code|
||when creating a new file|
||when performing minor changes/fixing the code or language|
||when improving performance|
||when writing docs|
||when reporting a bug, with
||when fixing a bug|
||when fixing something on Linux|
||when fixing something on Mac OS|
||when fixing something on Windows|
||when removing code or files, maybe with
||when change file structure. Usually together with 🎨|
||when refactoring code|
||when adding tests|
||when adding code coverage|
||when fixing the CI build|
||when dealing with security|
||when upgrading dependencies|
||when downgrading dependencies|
||when forward-porting features from an older version/branch|
||when backporting features from a newer version/branch|
||when removing linter/strict/deprecation warnings|
||when improving UI/Cosmetic|
||when improving accessibility|
||when dealing with globalization/internationalization/i18n/g11n|
WIP(Work In Progress) Commits, maybe with
||New Release with Python egg|
||New Release with Python wheel package|
||when Adding Logging|
||when Reducing Logging|
||when introducing New Features|
||when introducing Backward-InCompatible Features, maybe with
||New Idea, with
||changing Configuration, Usually together with 🐧 or 🎀 or 🚀|
||Customer requested application Customization, with
||Anything related to Deployments/DevOps|
||PostgreSQL Database specific (Migrations, Scripts, Extensions, ...)|
||MySQL Database specific (Migrations, Scripts, Extensions, ...)|
||MongoDB Database specific (Migrations, Scripts, Extensions, ...)|
||Generic Database specific (Migrations, Scripts, Extensions, ...)|
||when Merge files|
||when Commit Arise from one or more Cherry-Pick Commit(s)|
The Code is licensed under the MIT License.