This project is based on Conventional Commits. See their commit history for examples of properly formatted commit messages.
| Command | Returns |
|---|---|
git feat <message> |
feat: message |
git feat <scope> <message> |
feat(scope): message |
git docs <message> |
docs: message |
git docs <scope> <message> |
docs(scope): message |
git chore <message> |
chore: message |
git chore <scope> <message> |
chore(scope): message |
git fix <message> |
fix: message |
git fix <scope> <message> |
fix(scope): message |
git refactor <message> |
refactor: message |
git refactor <scope> <message> |
refactor(scope): message |
git style <message> |
style: message |
git style <scope> <message> |
style(scope): message |
git test <message> |
test: message |
git test <scope> <message> |
test(scope): message |
git build <message> |
build: message |
git build <scope> <message> |
build(scope): message |
git perf <message> |
perf: message |
git perf <scope> <message> |
perf(scope): message |
First, clone this repo. Preferably in your $HOME directory:
git clone [email protected]:imcvampire/git-semantic-commit.git ~/.git-semantic-commits
Then add the folder to your $PATH in ~/.bashrc or ~/.zshrc, respectively:
export PATH=$PATH:$HOME/.git-semantic-commits:$PATH
Save and source the changes:
source ~/.bashrc # if using Bash source ~/.zshrc # if using Zsh
That's it! Enjoy your workflow and consistency improvements 🎉
This repo is a fork of the original repo.