Generate Git Commit Message (Gitmoji Convention)

commit.md

Generate Git Commit Message (Gitmoji Convention)

Goal

Generate a well-structured Git commit message for the last staged project changes, strictly following the Gitmoji convention and best practices.

Context Analysis

• Staged Changes: Analyze the git diff --staged content to understand what changed.
• Commit Scope: Infer the context or scope (e.g., JIRA ticket, feature name) from the current branch name.

Steps

1. Select Gitmoji: Choose the most appropriate Gitmoji and its type (e.g., ✨ feat, 🐛 fix) that accurately reflects the primary change.
2. Compose the Title (First Line):

• Create a concise, imperative, and descriptive title.
• Format: <emoji> <type>: (context or ticket) <short, imperative description>

3. Compose the Body (Detailed Description):

• Provide a blank line after the title.
• Generate a detailed, bulleted list describing all major changes included in this commit.

4. Review

• Show the commit message
• Ask to run commit command
• If I confirm, do the commit message

Gitmoji examples

• ✨ feat: add a new feature
• 🐛 fix: fix a bug
• 🚑 hotfix: urgent critical fix
• ♻️ refactor: restructure code without changing behavior
• 🚀 perf: improve performance
• 🎨 style: code style changes (formatting, spacing, naming)
• ✏️ typofix: fix typos
• 🧹 chore: maintenance tasks (build, configs, housekeeping)
• ✅ test: add or update tests
• 📸 snapshot: update test snapshots
• 🧪 mock: add or update mocks
• 📝 docs: update documentation
• 🔊 logs: update log messages
• ➕ add: add a dependency
• ➖ remove: remove a dependency
• 🔥 remove: remove code or files
• ⬆️ upgrade: upgrade dependencies
• ⬇️ downgrade: downgrade dependencies
• ⌛ deps: lock or pin dependencies
• 📦 package: package or publish
• 🔖 release: new version or tag
• ⏪ revert: revert changes
• 🔒 security: fix security issues
• 🛂 auth: update authentication/authorization
• 🔧 config: update configuration
• 💚 ci: update CI pipelines
• 👷 build: update build system
• 🛠️ tool: update dev tools
• 🗃️ db: database changes
• 🗂️ assets: add or update assets (images, icons, fonts)
• 🏗️ infrastructure: infrastructure changes
• 🐳 docker: Docker-related changes
• 🆕 init: initialize project
• 🚧 wip: work in progress
• 🗑️ deprecate: mark code or files as deprecated
• 🔀 merge: merge branches
• 📱 mobile: mobile/responsive changes
• 💄 ui: UI/UX improvements
• 🌐 i18n: internationalization/localization
• 🧑‍💻 dev: developer experience improvements