git-cc

a git extension to help write conventional commits

Usage

# you can invoke either of the below to
# interactively write a conventional commit
git cc
git cc feat          # start after the commit-type
git cc 'feat(scope)' # start after the scope

# or validate your conventional commit
git cc feat: added conventional commits # ok! creates a commit
git cc 'feat(cli): added a conventional commit' # ok! creates a commit
git cc feat add a typo  # starts interaction at the scope
git cc -m "invalid(stuff): should return 1"

Configuration

See ./commit_convention.yml for an example configuration file.

Why write conventional commits through an interactive CLI?

Figuring out what to write for an informative commit can be difficult. The conventional commits standard helps figure out what to write. As a bonus, conventional commits facilitate generating changelogs and semantic version increments. An interactive command-line application helps with following the standard.

Installation

Go to the project releases page to download the appropriate package. Alternately, use the installer script at ./scripts/install.sh.

Please verify the the shasum of the downloaded executable for you before you run it. Alternately, verify that the installer script would correctly check the shasum of the downloaded package.

On linux or mac/darwin

repo=skalt/git-cc
branch=master
curl -sL https://raw.githubusercontent.com/$repo/$branch/scripts/install.sh | sh

Using platform-specific package managers

You can also use the install script to use platform-specific package managers. See the script's usage instructions for more details.

repo=skalt/git-cc
branch=master
curl -sL https://raw.githubusercontent.com/$repo/$branch/scripts/install.sh > /tmp/install.sh;
chmod +x /tmp/install.sh
/tmp/install.sh --help

From source with go

To compile from source, run make install inside the source directory. You'll need to have a go >= 1.13 toolchain and to have your $GOPATH/bin on your $PATH.

Prior art:

• committizen
• commitsar