#commit #git-commit #commit-message #git #generate #commitizen

app git-cm

A git command that generates conventional-friendly commit messages

9 releases

0.2.3 May 14, 2021
0.2.2 Mar 24, 2021
0.1.4 Jul 22, 2020

#2306 in Development tools

33 downloads per month

MIT/Apache

175KB
312 lines

git-cm

A git subcommand for creating conventional-friendly commit messages.

Installation

Either compile from source or install via crates.io:

$ cargo install git-cm --locked

For macOS, you can install git-cm via homebrew:

$ brew install sirwindfield/tap/git-cm

Usage

Instead of using git commit to commit changes, simply run git cm. This will start the questioning process and commit the message once you're done.

You also have to specifiy which types of commits your project supports. Just add the following to your Cargo.toml:

[package.metadata.commits]
defaults = true

# This is optional
[[package.metadata.commits.type]]
name = "xyz"
desc = "A custom command"

Example run

Example run GIF

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~14–24MB
~434K SLoC