My personal style guide for writing GitHub commit messages. More specifially, the prefixes. Prefixes should be written in the following format:
<prefix>: <message> (<reference>)
prefix should be either an emoji OR it’s name, not both. message is, of course, your commit message followed by reference, which is your issue or pull request reference (if applicable).
✨ This is a Work in Progress! ✨
| No. | Emoji | Names | Example |
|---|---|---|---|
| 01 | ✨🎁 | update, feat |
✨: add docstrings and type hinting |
| 02 | 🛠️🐞 | fix, bug |
🔨: fix broken control header (#4) |
| 03 | 🩹 🧷 | patch |
🩹: update token signing method for HTTP requests (#12) |
| ️️04 | 🔀 | merge |
🔀: merge pull request from user/patch-1 |
| 05 | ⬆️ | bump, upgrade |
⬆️: bump highlight.js from 1.1.2 to 1.2.0 |
| 06 | 🚨🔒 | security |
🔒: move exposed API key to .env file |
| 07 | 🏷️ | label, tag |
🏷️: release v0.1.1, 🏷️: v1.0.2 |
| 08 | 📝 | legal, docs, markdown |
📝: add GNU GPL v3 license, 📝: update contributing guide |
Git Commit Template:
<prefix>: <message> (<reference>)
# ✨ update: <message> (<reference>)
# 🎁 feat: <message> (<reference>)
# 🛠️ fix: <message> (<reference>)
# 🐞 bug: <message> (<reference>)
# 🩹🧷 patch: <message>
# 🔀 merge: <message>
# 🚨🔒 security:
# 🏷️ tag
# 📝 doc: <message> (<reference>)