A commit message format that uses emojis for quick visual identification.
π€· it's fun. - don't take it too seriously.
emoji (scope) description
emoji- one of the type emojis (see below)(scope)- optional contextdescription- present tense, max 72 characters
| Emoji | Type | Description | Conventional Equivalent |
|---|---|---|---|
| β¨ | feature | new functionality / new UI | feat |
| π | fix | fix bugs, errors, issues | fix |
| π¨ | refactor | code refactors | refactor |
| π§ͺ | test | add / update tests | test |
| π | docs | documentation changes | docs |
| ποΈ | performance | performance improvement | perf |
| π¦ | build | dependencies, build, CI/CD | build, ops |
| π§Ή | chore | maintenance, cleanup, misc. changes | chore, style |
featβ β¨fixβ πrefactorβ π¨testβ π§ͺdocsβ πperfβ ποΈbuild,opsβ π¦chore,styleβ π§Ή
- One emoji per commit - No combining types
- Lowercase start - Except proper nouns, brands, or technical terms (API, OAuth, Docker)
- Present tense - "add" not "added", "fix" not "fixed"
- 72 character limit - For clean display in
git log --oneline- if you need more, put it in the body, or split into smaller commits
- Optional scope - Use
(scope)for context: modules, components, files (e.g.,(auth),(cart)), etc.- to mark a breaking change, append
!after the closing parenthesis:(scope)!
- to mark a breaking change, append
- No empty descriptions - Always provide meaningful description
β¨ add user authentication system
β¨ (auth) add OAuth integration
π fix login redirect loop
π (ui) fix navigation menu overflow
π¨ simplify user service module
π¨ (utils) extract validation helpers
π§ͺ add unit tests for user service
π update API documentation
π (readme) add installation instructions
π§Ή apply gofmt
β¨ improve mobile responsiveness
β¨ (dashboard) redesign layout
ποΈ cache user info after login
π¦ update dependencies
π¦ (ci) add GitHub Actions workflow
π§Ή add build artifacts to .gitignore
π¨ (cfg)! change default database port to 5433
886bb7c7 β¨ add user authentication system
9a4d2f1e π (ui) fix navigation menu overflow
1c7b5a3f π update API documentation
7d8e9b0a π¨ simplify user service module
2f5c6d4b π§ͺ add unit tests for user service
d34db44f π¨ (api)! remove `old_login` endpoint
9e3a7b5c β¨ redesign dashboard layout
6d8c3e9f π¦ update dependencies
137ee79a π§Ή add build artifacts to .gitignore
Like it? Make it yours! Use whatever emojis you prefer - embrace the sillinessπΊ