GITMOJI_COMMIT_TEMPLATE.md

📝 Commit Message Template

Choose the one that fits the best below.

Step 1: Choose Your Commit Type and Gitmoji

Select the type of change (choose one):

• 🎨 Improve structure / format of the code
• ⚡️ Improve performance
• 🔥 Remove code or files
• 🐛 Fix a bug
• 🚑️ Critical hotfix
• ✨ Introduce new features
• 📝 Add or update documentation
• 🚀 Deploy stuff
• 💄 Add or update the UI and style files
• 🎉 Initial commit
• ✅ Add, update, or pass tests
• 🔒 Fix security or privacy issues
• 🔐 Add or update secrets
• 🔖 Release / Version tags
• 🚨 Fix compiler / linter warnings
• 🚧 Work in progress
• 💚 Fix CI Build
• ⬇️ Downgrade dependencies
• ⬆️ Upgrade dependencies
• 📌 Pin dependencies to specific versions
• 👷 Add or update CI build system
• 📈 Add or update analytics or track code
• ♻️ Refactor code
• ➕ Add a dependency
• ➖ Remove a dependency
• 🔧 Add or update configuration files
• 🔨 Add or update development scripts
• 🌐 Internationalization and localization
• ✏️ Fix typos
• 💩 Write bad code that needs to be improved
• ⏪ Revert changes
• 🔀 Merge branches
• 📦 Add or update compiled files or packages
• 👽️ Update code due to external API changes
• 🚚 Move or rename resources (e.g.: files, paths, routes)
• 📄 Add or update license
• 💥 Introduce breaking changes
• 🍱 Add or update assets
• ♿️ Improve accessibility
• 💡 Add or update comments in source code
• 🍻 Write code drunkenly
• 💬 Add or update text and literals
• 🗃️ Perform database related changes
• 🔊 Add or update logs
• 🔇 Remove logs
• 👥 Add or update contributor(s)
• 🚸 Improve user experience / usability
• 🏗️ Make architectural changes
• 📱 Work on responsive design
• 🤡 Mock things
• 🥚 Add or update an easter egg
• 🙈 Add or update a .gitignore file
• 📸 Add or update snapshots
• ⚗️ Perform experiments
• 🔍 Improve SEO
• 🏷️ Add or update types
• 🌱 Add or update seed files
• 🚩 Add, update, or remove feature flags
• 🥅 Catch errors
• 💫 Add or update animations and transitions
• 🗑️ Deprecate code that needs to be cleaned up
• 🛂 Work on code related to authorization, roles and permissions
• 🩹 Simple fix for a non-critical issue
• 🧐 Data exploration/inspection
• ⚰️ Remove dead code
• 🧪 Add a failing test
• 👔 Add or update business logic
• 🩺 Add or update healthcheck
• 🧱 Infrastructure related changes
• 🧑‍💻 Improve developer experience
• 💸 Add sponsorships or money related infrastructure
• 🧵 Add or update code related to multithreading or concurrency
• 🦺 Add or update code related to validation

---

Step 2: Specify Scope (Optional)

Enter the scope in parentheses (e.g., auth, api, ui, components, account, etc.):

---

Step 3: Write Short Description

Write a brief, imperative description (e.g., "add user authentication"):

---

Format Rules

1. Structure: [(scope)]:
2. Use imperative mood ("add" not "added")
3. Description should be lowercase
4. No period at the end of the description
5. Keep commit message under 72 characters

Examples:

• ⚡️ lazyload home screen images
• 🐛 fix onClick event handler
• 🔖 bump version 1.2.0
• ♻️ (components): transform classes to hooks
• 📈 add analytics to the dashboard
• 🌐 support Japanese language
• ♿️ (account): improve modals a11y

Tips:

• Look for main keyword and use only strict emoji (max 1)
• Be specific in your scope
• Keep descriptions concise but informative
• Always mention breaking changes
• Reference issues when applicable