|
| 1 | +# Git Semantic Commit Messages |
| 2 | + |
| 3 | +This repo is a fork of original repo https://github.com/russiann/git-semantic-commits |
| 4 | + |
| 5 | +This project is based on [Karma Git Commit Convention](http://karma-runner.github.io/1.0/dev/git-commit-msg.html). |
| 6 | +See their commit history for examples of properly-formatted commit messages. |
| 7 | + |
| 8 | +### Commands: |
| 9 | + |
| 10 | +| Command | Return | |
| 11 | +| --------------------- | ------------------------------- | |
| 12 | +| `git feat <message>` | feat: message | |
| 13 | +| `git feat <scope> <message>` | feat(scope): message | |
| 14 | +| `git docs <message>` | docs: message | |
| 15 | +| `git docs <scope> <message>` | docs(scope): message | |
| 16 | +| `git chore <message>` | chore: message | |
| 17 | +| `git chore <scope> <message>` | chore(scope): message | |
| 18 | +| `git fix <message>` | fix: message | |
| 19 | +| `git fix <scope> <message>` | fix(scope): message | |
| 20 | +| `git refactor <message>` | refactor: message | |
| 21 | +| `git refactor <scope> <message>` | refactor(scope): message | |
| 22 | +| `git style <message>` | style: message | |
| 23 | +| `git style <scope> <message>` | style(scope): message | |
| 24 | +| `git test <message>` | test: message | |
| 25 | +| `git test <scope> <message>` | test(scope): message | |
| 26 | +| `git localize <message>` | localize: message | |
| 27 | +| `git localize <scope> <message>` | localize(scope): message | |
| 28 | + |
| 29 | + |
| 30 | +## Manual Installation: |
| 31 | + |
| 32 | +1. Clone this repo, prefferably in your $HOME directory. |
| 33 | +``` |
| 34 | +git clone [email protected]:imcvampire/git-semantic-commit.git ~/.git-semantic-commits |
| 35 | +``` |
| 36 | + |
| 37 | +2. Add the folder to your $PATH. |
| 38 | + * if using Bash, open ```~/.bashrc``` with your favourite editor and add this line: |
| 39 | + ``` |
| 40 | + export PATH=$PATH:$HOME/.git-semantic-commits:$PATH |
| 41 | + ``` |
| 42 | + * if using Zsh, open ```~/.zshrc``` with your favourite editor and add this line: |
| 43 | + ``` |
| 44 | + export PATH=$PATH:$HOME/.git-semantic-commits:$PATH |
| 45 | + ``` |
| 46 | + |
| 47 | +3. Save the file and source the changes in bashrc/zshrc: ```source ~/.bashrc``` or ```source ~/.zshrc``` |
| 48 | + |
| 49 | +4. Done! |
0 commit comments