https://github.com/theapache64/ugh
Commit messages beautified 💖
https://github.com/theapache64/ugh
Last synced: 9 months ago
JSON representation
Commit messages beautified 💖
- Host: GitHub
- URL: https://github.com/theapache64/ugh
- Owner: theapache64
- License: apache-2.0
- Created: 2019-02-08T15:40:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T05:35:56.000Z (over 2 years ago)
- Last Synced: 2024-05-01T15:33:26.340Z (almost 2 years ago)
- Language: Kotlin
- Size: 18.4 MB
- Stars: 13
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ugh
Commit messages beautified 💖
### Installation
Download [ugh.jar](ugh.jar) and [dictionary.json](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.
### Example
##### Normal way
`commit`
`result`
##### Ugh Way
`commit`
`result`
### Commit Types
| Emoji | Raw Emoji Code | Type | Description |
|:--------------------------:|------------------------------|--------------------|-------------|
| :star: | `:star:` | `feature` | add **new feature** |
| :bug: | `:bug:` | `bug` | fix **bug** issue |
| :ambulance: | `:ambulance:` | `critical-bug` | ciritial hotfix **bug** issue |
| :lock: | `:lock:` | `security` | fix **security** issue |
| :chart_with_upwards_trend: | `:chart_with_upwards_trend:` | `performance` | fix **performance** issue |
| :zap: | `:zap:` | `improvement` | update **backwards-compatible** feature |
| :boom: | `:boom:` | `breaking` | update **backwards-incompatible** feature |
| :warning: | `:warning:` | `deprecated` | **deprecate** feature |
| :globe_with_meridians: | `:globe_with_meridians:` | `i18n` | update or fix **internationalization** |
| :wheelchair: | `:wheelchair:` | `a11y` | update or fix **accessibility** |
| :lipstick: | `:lipstick:` | `ui-update` | update **UI/Cosmetic** |
| :up: | `:up:` | `update` | update **other** |
| :rotating_light: | `:rotating_light:` | `non-code-refactor` | remove **linter**/strict/deprecation warnings |
| :shirt: | `:shirt:` | `code-refactor` | **refactoring** or code **layouting** |
| :white_check_mark: | `:white_check_mark:` | `test-add` | add **tests** |
| :green_heart: | `:green_heart:` | `test-fix` | fix **tests** failure or **CI** building |
| :pencil: | `:pencil:` | `docs-update` | update **documentation** |
| :copyright: | `:copyright:` | `licence` | decide or change **license** |
| :lollipop: | `:lollipop:` | `example` | for **example** or **demo** codes |
| :arrow_up: | `:arrow_up:` | `dependency-up` | upgrade **dependencies** |
| :arrow_down: | `:arrow_down:` | `dependency-down` | downgrade **dependencies** |
| :pushpin: | `:pushpin:` | `dependency-pin` | pin **dependencies** |
| :wrench: | `:wrench:` | `config` | update **configuration** |
| :package: | `:package:` | `build` | **packaging** or **bundling** or **building** |
| :hatching_chick: | `:hatching_chick:` | `release-init` | **initial** commit |
| :confetti_ball: | `:confetti_ball:` | `release-major` | release **major** version |
| :tada: | `:tada:` | `release-minor` | release **minor** version |
| :sparkles: | `:sparkles:` | `release-patch` | release **patch** version |
| :rocket: | `:rocket:` | `release-deploy` | **deploy** to production enviroment |
| :bookmark: | `:bookmark:` | `release-tagged` | **tagged** with version label |
| :back: | `:back:` | `revert` | **revert** commiting |
| :construction: | `:construction:` | `wip` | **WIP** commiting |
| :truck: | `:truck:` | `move` | **move** or **rename** files, repository, ... |
| :twisted_rightwards_arrows:| `:twisted_rightwards_arrows:`| `merge` | merge **conflict resolution** |
| :heavy_plus_sign: | `:heavy_plus_sign:` | `add` | **add** files, dependencies, ... |
| :heavy_minus_sign: | `:heavy_minus_sign:` | `remove` | **remove** files, dependencies, ... |
| :on: | `:on:` | `enable` | **enable** feature and something ... |
### Author
theapache64 - theapache64@gmail.com
Inspired from [kazupon/git-commit-message-convention](https://github.com/kazupon/git-commit-message-convention)