Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 1.33 KB

README.md

File metadata and controls

52 lines (33 loc) · 1.33 KB

git-cm

docs_master_badge

A git subcommand for creating conventional-friendly commit messages.

Installation

Either compile from source or install via crates.io:

cargo install 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

at your option.

Contribution

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.