Skip to content

signothecat/gitmoji-commit-message-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

20 Commits
Β 
Β 

Repository files navigation

Use gitmoji(Emoji) for Commit MessageπŸš€

This is a ready-to-use commit message template to keep your history visually better.
Use it by setting it in commit.template.

There's also a simple guide to using gitmoji as commit message prefixes below.

gitmoji Prefix Template

#✨ feat: 
#β”” Add new feature
#🐞 fix: 
#β”” Fix a bug (including security fixes)
#πŸ“ docs: 
#β”” Add or update documentation
#πŸ’„ ui: 
#β”” Update UI and style files
#⚑ perf: 
#β”” Improve performance
#♻️ refactor: 
#β”” Refactor code without changing functionality
#🎨 style: 
#β”” Changes that do not affect the meaning of the code
#  (white-space, missing semi-colon, etc.)
#🍱 assets: 
#β”” Add or update assets
#πŸ—‘οΈ remove: 
#β”” Remove code or files
#πŸ§ͺ test: 
#β”” Add or update tests
#πŸ“¦ build: 
#β”” Add or update build system or dependencies
#πŸš‘ hotfix: 
#β”” Critical hotfix
#πŸ”§ chore: 
#β”” Add or update configuration files or scripts
#🚧 wip: 
#β”” Work in progress
#βͺ revert: 
#β”” Revert changes
#πŸ”€ merge: 
#β”” Merge branches
#🏷️ release: 
#β”” Release / Version tags
#πŸš€ deploy: 
#β”” Deploy stuff
#πŸŽ‰ init: 
#β”” Begin a project

How to use the template?

First, create ~/.gitmessage (name and location optional) by touch.

touch ~/.gitmessage.txt

Then, copy the template and paste it into created file.
Lastly, set that file as a template in git config.

git config --global commit.template ~/.gitmessage.txt

You're all set! πŸŽ‰
Uncomment out the line for use to write a comment!

gitmoji Prefix Usage

gitmoji Prefix Description Example
✨ :sparkles: feat Add new feature ✨ feat: add user profile editing feature
🐞 :lady_beetle: fix Fix a bug (including security fixes) 🐞 fix: fix display failure
πŸ“ :memo: docs Add or update documentation πŸ“ docs: add new endpoint to API specification
πŸ’„ :lipstick: ui Update UI and style files πŸ’„ ui: change button color to brand color
⚑ :zap: perf Improve performance ⚑ perf: reduce API response time by 300ms
♻️ :recycle: refactor Refactor code without changing functionality ♻️ refactor: split authentication process into functions
🎨 :art: style Changes that do not affect the meaning of the code (white-space, missing semi-colon, etc.) 🎨 style: unify indentation to 2 spaces
🍱 :bento: assets Add or update assets 🍱 assets: add new logo image
πŸ—‘οΈ :wastebasket: remove Remove code or files πŸ—‘οΈ remove: delete deprecated API endpoint
πŸ§ͺ :test_tube: test Add or update tests πŸ§ͺ test: add unit tests for user registration API
πŸ“¦ :package: build Add or update build system or dependencies πŸ“¦ build: update lodash to v4.17.21
πŸš‘ :ambulance: hotfix Critical hotfix πŸš‘ hotfix: fix crash in production environment
πŸ”§ :wrench: chore Add or update configuration files or scripts πŸ”§ chore: update ESLint config and DB init script
🚧 :construction: wip Work in progress 🚧 wip: implement partial UI for dashboard
βͺ :rewind: revert Revert changes βͺ revert: revert commit abc123
πŸ”€ :twisted_rightwards_arrows: merge Merge branches πŸ”€ merge: merge feature/login into develop
🏷️ :bookmark: release Release / Version tags 🏷️ release: v1.0.0
πŸš€ :rocket: deploy Deploy stuff πŸš€ deploy: release v1.2.0 to production
πŸŽ‰ :tada: init Begin a project πŸŽ‰ init: create project structure

About

Guide and simple template for using gitmoji(emoji) with prefixes of commit messages

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published