Commit messages beautified 💖
Download ugh.jar and dictionary.json into one directory. Then, add this shortcut to your .bashrc file
# Build commit message interactively
function commit-clean(){
git add -A &&
java -jar /path/to/ugh.jar clean
}
# Build commit message quickly
function commit-quick(){
git add -A &&
java -jar /path/to/ugh.jar quick "$1"
}
# Build commit message quick + less interactive
function commit-quick-i(){
git add -A &&
java -jar /path/to/ugh.jar quick-i
}
and from your git directory, try those shortcuts.
commit
result
commit
result
| Emoji | Raw Emoji Code | Type | Description |
|---|---|---|---|
| ⭐ | :star: |
feature |
add new feature |
| 🐛 | :bug: |
bug |
fix bug issue |
| 🚑 | :ambulance: |
critical-bug |
ciritial hotfix bug issue |
| 🔒 | :lock: |
security |
fix security issue |
| 📈 | :chart_with_upwards_trend: |
performance |
fix performance issue |
| ⚡ | :zap: |
improvement |
update backwards-compatible feature |
| 💥 | :boom: |
breaking |
update backwards-incompatible feature |
:warning: |
deprecated |
deprecate feature | |
| 🌐 | :globe_with_meridians: |
i18n |
update or fix internationalization |
| ♿ | :wheelchair: |
a11y |
update or fix accessibility |
| 💄 | :lipstick: |
ui-update |
update UI/Cosmetic |
| 🆙 | :up: |
update |
update other |
| 🚨 | :rotating_light: |
non-code-refactor |
remove linter/strict/deprecation warnings |
| 👕 | :shirt: |
code-refactor |
refactoring or code layouting |
| ✅ | :white_check_mark: |
test-add |
add tests |
| 💚 | :green_heart: |
test-fix |
fix tests failure or CI building |
| 📝 | :pencil: |
docs-update |
update documentation |
| ©️ | :copyright: |
licence |
decide or change license |
| 🍭 | :lollipop: |
example |
for example or demo codes |
| ⬆️ | :arrow_up: |
dependency-up |
upgrade dependencies |
| ⬇️ | :arrow_down: |
dependency-down |
downgrade dependencies |
| 📌 | :pushpin: |
dependency-pin |
pin dependencies |
| 🔧 | :wrench: |
config |
update configuration |
| 📦 | :package: |
build |
packaging or bundling or building |
| 🐣 | :hatching_chick: |
release-init |
initial commit |
| 🎊 | :confetti_ball: |
release-major |
release major version |
| 🎉 | :tada: |
release-minor |
release minor version |
| ✨ | :sparkles: |
release-patch |
release patch version |
| 🚀 | :rocket: |
release-deploy |
deploy to production enviroment |
| 🔖 | :bookmark: |
release-tagged |
tagged with version label |
| 🔙 | :back: |
revert |
revert commiting |
| 🚧 | :construction: |
wip |
WIP commiting |
| 🚚 | :truck: |
move |
move or rename files, repository, ... |
| 🔀 | :twisted_rightwards_arrows: |
merge |
merge conflict resolution |
| ➕ | :heavy_plus_sign: |
add |
add files, dependencies, ... |
| ➖ | :heavy_minus_sign: |
remove |
remove files, dependencies, ... |
| 🔛 | :on: |
enable |
enable feature and something ... |
theapache64 - [email protected]
Inspired from kazupon/git-commit-message-convention