https://github.com/satansdeer/git-emoji-commits
https://github.com/satansdeer/git-emoji-commits
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/satansdeer/git-emoji-commits
- Owner: satansdeer
- License: mit
- Created: 2018-04-21T17:04:41.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-21T17:42:39.000Z (about 7 years ago)
- Last Synced: 2025-02-05T05:28:15.675Z (4 months ago)
- Language: Shell
- Size: 3.91 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Semantic Git commit messages with emojis
Basically it's a fork of [fteem](https://github.com/fteem)'s [git-semantic-commits](https://github.com/fteem/git-semantic-commits), but instead of words it adds emojis.
Inspired by Sparkbox's awesome article on [semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages).
## What is this?
These are **very simple** custom git commands that enforce the git user to write better git commit messages. If still confused, read the article above. Instead of text it adds emojis
# Commit emojis
| emoji | code | description |
|:-----:|------|-------------|
| :construction_worker: | `:construction_worker:` | chore |
| :memo: | `:memo:` | docs |
| :heavy_plus_sign: | `:heavy_plus_sign:` | feat |
| :beetle: | `:beetle:` | fix |
| :globe_with_meridians: | `:globe_with_meridians:` | localize |
| :hammer_and_wrench: | `:hammer_and_wrench:` | refactor |
| :lipstick: | `:lipstick:` | style |
| :space_invader: | `:space_invader:` | test |
## Installation:
1. Clone this repo, preferably in your $HOME directory. ```git clone https://github.com/fteem/git-semantic-commits ~/.git-semantic-commits```
Tip: If you're using Cygwin, open it and type 'echo $USERPROFILE'. This will show you the location of the $HOME directory.
2. Install it as a set of bash scripts or git aliases:
* bash scripts: ```cd ~/.git-semantic-commits && ./install.sh --scripts```
* git aliases ```cd ~/.git-semantic-commits && ./install.sh```
Tip: Installation script is idempotent and could be harmlessly executed multiple times. It adds bash scripts to the PATH in your `~/.bashrc` or `~/.zshrc` files or adds git aliases to the `~/.gitconfig` file respectively (without any duplication).
3. Commit away!
## Usage
There are 8 new Git commands now.
New command -> what it does:
* ```git feat "commit message here"``` -> ```git commit -m '➕ commit message here'```
* ```git docs "commit message here"``` -> ```git commit -m '📝 commit message here'```
* ```git chore "commit message here"``` -> ```git commit -m '👷 commit message here'```
* ```git fix "commit message here"``` -> ```git commit -m '🐞 commit message here'```
* ```git refactor "commit message here"``` -> ```git commit -m '🛠 commit message here'```
* ```git style "commit message here"``` -> ```git commit -m '💄 commit message here'```
* ```git test "commit message here"``` -> ```git commit -m '👾 commit message here'```
* ```git localize "commit message here"``` -> ```git commit -m '🌐 commit message here'```
If you would like to add an optional scope, as described [here](https://conventionalcommits.org/), use the '-s' flag and quote the scope message:
* ```git docs -s "scope here" "commit message here"``` -> ```git commit -m '📝(scope here): commit message here'```
If you would still like to use your text editor for your commit messages
you can omit the message, and do your commit message in your editor.
* ```git feat``` -> ```git commit -m '➕ ' -e```
Aliases for those who use [git-extras](https://github.com/tj/git-extras) (will be installed only if you have `git-extras`):
* ```git rf "commit message here"``` -> ```git commit -m '🛠 commit message here'```
* ```git ch "commit message here"``` -> ```git commit -m '👷 commit message here'```
## How to contribute
Open a pull request/issue or fork this repo and submit your changes via a pull request.