git-cc

README

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

Documentation

Overview

Copyright © 2024 Austin Sabel austin.sabel@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.