git-cc: Conventional Commits Git Command

git-cc is interactive git sub-command that will help you craft beautify and informative commit message that adhere to the Conventional Commits standard.

---

Installation  |  Usage  |  Configuration

---

Installation

Mac OS / Homebrew

brew tap 45413/tap
brew install git-cc

Pre-complied binaries for all OSes

Go to releases page and download latest version for your OS. Extract archive and copy git-cc to a directory in your $PATH/%PATH%

Build and Install From Source

go install github.com/45413/git-cc

Ensure go bin directory to your path export PATH=${PATH}:$(go env GOPATH)/bin

Usage

To invoke simply run git cc

Configuration

git-cc supports a simple yaml based configuration to customize the prompt behavoir on a repo basis. Simply add a .git-cc.yaml into the root of the repository. See .git-cc.example.yaml

# .git-cc.yaml
use_defaults: true
custom_commit_types: 
  - build
  - chore
  - ci
  - docs
  - style
  - refactor
  - perf
  - test
scopes: 
  - config
  - manpage
  - prompt
  - readme
  - scripts

property	options
use_defaults	If true use default commit types (default: true)
custom_commit_types	Custom commit types to include when prompting, appended to defaults if use_defaults: true
scopes	List of available scopes