- About
- Git Projects
- README Template
- LICENSE_Template
- Contributing_Template
- Commit Message Format
- Tag Message Format
- Notes
- Git config and GPGsign
- Suggested Emojis
- Tools
- Fun Emoji Usages
- Contributing
- License
- Thanks to
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.
Please make as many commits as possible. The principle here is small commits. A version tag must then be set for each related change.
- Every change must commit.
- All related changes must be combined in a new version.
- Every new version must be tagged.
- Every project name must must be lower case.
- Every project must have an easily recognizable name. The blanks in the project name are filled in with the character _.
- Every project must have a description.
- Every project must have a project avatar.
- Projects that belong together must be marked with a project description. For example: chef_example_cookbook
Please use the README_template for normal projects. Please use the README_chef_template for chef projects.
Please use the GNU Affero General Public License v3.0 for normal projects.
Please use the CONTRIBUTING for for projects.
All Git Commit Messages MUST be signed!
All Git Commit Messages MUST meet with this Text Format:
:emoji1: :emoji2: Subject
(Only One NewLine)
Message Body
(Only One NewLine)
Ref <###>
All Git Tag Messages MUST be signed!
All Git Tag Messages MUST meet with this Text Format:
Release vSemVer
- Capitalize the Subject.
- Do not end the Subject line with a period.
- Message Subject SHOULD Begin with at-least One Emoji(see below for list of Suggested Emojis).
- Message Body SHOULD End with at-least One Issue Tracking ID Reference(GitHub Issues/GitLab Issues/Phabricator Tasks), Ex.
Issue #27,Ref T27orRef T27, T56orFixes T8. It's also recommanded to use Full URL to Issues, instead of just Issue ID Number; Doing so will ease browsing issues from terminal. - Total Characters of the Subject Line MUST be Less than or Equal to 50 Chars Long.
- Wrap the Message body at 72 characters.
- Use Valid MarkDown format in Message Body.
- Use the Present Tense ("Add feature" not "Added feature").
- Use the Imperative Mood ("Move cursor to..." not "Moves cursor to...").
- Use the Message body to explain what and why vs. how.
- All WIP(Work In Progress) Commits MUST have the WIP Emoji(see below).
- All WIP Commits Should be Avoided!.
- Refrencing Issues by using special keywords like
FixesorResolveswill mark them as closed automatically! For more information about automatic issue closing using ketwords see: GitHub/GitLab/Phabricator. - There is a Space Character between Multiple Emojis!.
- There is NO New-Line After the Task ID Reference Line.
- Every Raw Emoji Text(
:emoji:) is Counted as One Char!. - See ToDo Grammar StyleGuide for more Information on
@XXXComment Tags.
All commit messages and tags must be signed!
gpg --list-secret-keys --keyid-format LONG
sec ed25519 2018-02-26 [SC] [expires: 2022-02-25]
101D2615211421D8D22218DFD68251B5B79A051A
uid [ultimate] Robert Ressl <robert.ressl@safematix.ch>
ssb cv25519 2018-02-26 [E] [expires: 2022-02-25]
git config --global user.signingkey 101D2615211421D8D22218DFD68251B5B79A051A
git config --global user.name "Ressl Robert"
git config --global user.email "robert.ressl@safematix.ch"
git config --global commit.gpgsign true
git config --global tag.gpgsign true
| Emoji | Raw Emoji Code | Description |
|---|---|---|
| 🎉 | :tada: |
Initial Commit |
| 🎨 | :art: |
when improving the format/structure of the code |
| ✨ | :sparkles: |
when introducing New Features |
| 📰 | :newspaper: |
when creating a new file |
| 📝 | :pencil: |
when performing minor changes/fixing the code or language |
| 📚 | :books: |
when writing docs |
| 🐛 | :bug: |
when reporting a bug, with @FIXMEComment Tag |
| 🚑 | :ambulance: |
when fixing a bug |
| 🔥 | :fire: |
when removing code or files, maybe with @CHANGED Comment Tag |
| 🚜 | :tractor: |
when change file structure. Usually together with 🎨 |
| 🔨 | :hammer: |
when refactoring code |
| ☔ | :umbrella: |
when adding tests |
| 💎 | :gem: |
New Release |
| 🔖 | :bookmark: |
Version Tags |
| ❄️ | :snowflake: |
changing Configuration, Usually together with 🐧 or 🎀 or 🚀 |
| 🎀 | :ribbon: |
Customer requested application Customization, with @HACK Comment Tag |
| 🚀 | :rocket: |
Anything related to Deployments/DevOps |
| 🤝 | :handshake: |
when Merge files |
| 📁 | :file_folder: |
when working with Git Submodules |
| Emoji | Raw Emoji Code | Description |
|---|---|---|
| 🎨 | :art: |
when improving the format/structure of the code |
| 📰 | :newspaper: |
when creating a new file |
| 📝 | :pencil: |
when performing minor changes/fixing the code or language |
| 🐎 | :racehorse: |
when improving performance |
| 📚 | :books: |
when writing docs |
| 🐛 | :bug: |
when reporting a bug, with @FIXMEComment Tag |
| 🚑 | :ambulance: |
when fixing a bug |
| 🐧 | :penguin: |
when fixing something on Linux |
| 🍎 | :apple: |
when fixing something on Mac OS |
| 🏁 | :checkered_flag: |
when fixing something on Windows |
| 🔥 | :fire: |
when removing code or files, maybe with @CHANGED Comment Tag |
| 🚜 | :tractor: |
when change file structure. Usually together with 🎨 |
| 🔨 | :hammer: |
when refactoring code |
| ☔ | :umbrella: |
when adding tests |
| 🔬 | :microscope: |
when adding code coverage |
| 💚 | :green_heart: |
when fixing the CI build |
| 🔒 | :lock: |
when dealing with security |
| ⬆️ | :arrow_up: |
when upgrading dependencies |
| ⬇️ | :arrow_down: |
when downgrading dependencies |
| ⏩ | :fast_forward: |
when forward-porting features from an older version/branch |
| ⏪ | :rewind: |
when backporting features from a newer version/branch |
| 👕 | :shirt: |
when removing linter/strict/deprecation warnings |
| 💄 | :lipstick: |
when improving UI/Cosmetic |
| ♿ | :wheelchair: |
when improving accessibility |
| 🌐 | :globe_with_meridians: |
when dealing with globalization/internationalization/i18n/g11n |
| 🚧 | :construction: |
WIP(Work In Progress) Commits, maybe with @REVIEW Comment Tag |
| 💎 | :gem: |
New Release |
| 🔖 | :bookmark: |
Version Tags |
| 🎉 | :tada: |
Initial Commit |
| 🔈 | :speaker: |
when Adding Logging |
| 🔇 | :mute: |
when Reducing Logging |
| ✨ | :sparkles: |
when introducing New Features |
| ⚡ | :zap: |
when introducing Backward-InCompatible Features, maybe with @CHANGED Comment Tag |
| 💡 | :bulb: |
New Idea, with @IDEA Comment Tag |
| ❄️ | :snowflake: |
changing Configuration, Usually together with 🐧 or 🎀 or 🚀 |
| 🎀 | :ribbon: |
Customer requested application Customization, with @HACK Comment Tag |
| 🚀 | :rocket: |
Anything related to Deployments/DevOps |
| 🐘 | :elephant: |
PostgreSQL Database specific (Migrations, Scripts, Extensions, ...) |
| 🐬 | :dolphin: |
MySQL Database specific (Migrations, Scripts, Extensions, ...) |
| 🍃 | :leaves: |
MongoDB Database specific (Migrations, Scripts, Extensions, ...) |
| 🏦 | :bank: |
Generic Database specific (Migrations, Scripts, Extensions, ...) |
| 🐳 | :whale: |
Docker Configuration |
| 🤝 | :handshake: |
when Merge files |
| 📁 | :file_folder: |
when working with Git Submodules |
- Commit(CLI): This is a nifty CLI tool to aid in standardizing commit messages based on this document, thanks to @jakeasmith.
- gitMoji(Chrome Extension): Enhance your commits with emojis!, thanks to @louisgrasset.
- CodeEmoji: Mozilla’s Codemoji enciphers your messages with emoji for fun and profit
- Emoji Based Diagram: Emoji Based Diagram of Data Bearing Subscription Updates(WebPush VAPID)
Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.
To add a new Emoji to the list: Create an Issue.
- v1.0.0 - Initial work
- v1.0.1 - fix CONTRIBUTING and add template, version list
- v1.1.0 - add add Git Principle and fix typo
- v1.2.0 - add add Emoji 📁
- v1.3.0 - add add CHANGELOG_template.md
- Robert Ressl - Initial work & improvement - Robert Ressl
The Code is licensed under the GNU Affero General Public License v3.0