Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.67 KB

COMMIT_EMOJIS.md

File metadata and controls

28 lines (22 loc) · 1.67 KB

Commit Emoji Conventions

To make the commit history more readable and structured, we use emojis to denote the types of changes. Please follow these rules when creating commit messages.

Emoji Commit Type Description
🎉 happy Mega happiness
feat Adding a new feature
🐛 fix Fixing a bug
📝 docs Updating documentation
🎨 style Changes in styling (e.g., formatting, missing semi colons)
♻️ refactor Code refactoring without functional changes
test Adding tests
🔨 build Changes in the build system or external dependencies
perf Improving performance
🔧 chore Other changes that don't modify src or test files

Example Commit Messages

  • feat: added user authentication
  • fix: fixed display issue on mobile devices
  • docs: updated installation guide

General Guidelines

  1. Use one emoji per commit.
  2. Start the commit message with the emoji and commit type.
  3. Follow the Conventional Commits standard.