https://github.com/imcvampire/git-semantic-commit
A list of simple bash script for faster git commit
https://github.com/imcvampire/git-semantic-commit
hacktoberfest
Last synced: 4 months ago
JSON representation
A list of simple bash script for faster git commit
- Host: GitHub
- URL: https://github.com/imcvampire/git-semantic-commit
- Owner: imcvampire
- License: mit
- Created: 2016-10-24T05:03:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T21:34:34.000Z (almost 2 years ago)
- Last Synced: 2025-04-14T08:41:18.085Z (about 1 year ago)
- Topics: hacktoberfest
- Language: Shell
- Homepage:
- Size: 28.3 KB
- Stars: 15
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Semantic Commit Messages
This project is based on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). See their commit history for examples of properly formatted commit messages.
## Commands
| Command | Returns |
| --------------------- | ------------------------------- |
| `git feat ` | feat: message |
| `git feat ` | feat(scope): message |
| `git docs ` | docs: message |
| `git docs ` | docs(scope): message |
| `git chore ` | chore: message |
| `git chore ` | chore(scope): message |
| `git fix ` | fix: message |
| `git fix ` | fix(scope): message |
| `git refactor ` | refactor: message |
| `git refactor ` | refactor(scope): message |
| `git style ` | style: message |
| `git style ` | style(scope): message |
| `git test ` | test: message |
| `git test ` | test(scope): message |
| `git build ` | build: message |
| `git build ` | build(scope): message |
| `git perf ` | perf: message |
| `git perf ` | perf(scope): message |
## Install
First, clone this repo. Preferably in your $HOME directory:
```sh
git clone git@github.com:imcvampire/git-semantic-commit.git ~/.git-semantic-commits
```
Then add the folder to your `$PATH` in `~/.bashrc` or `~/.zshrc`, respectively:
```sh
export PATH=$PATH:$HOME/.git-semantic-commits:$PATH
```
Save and source the changes:
```sh
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](https://github.com/russiann/git-semantic-commits).