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.
#β¨ 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
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 | 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 |