https://github.com/mainrs/git-cm

Easily create conventional-commits friendly commit messages.
https://github.com/mainrs/git-cm

cli conventional-commits git git-subcommand

Last synced: 5 days ago
JSON representation

Easily create conventional-commits friendly commit messages.

• Host: GitHub
• URL: https://github.com/mainrs/git-cm
• Owner: mainrs
• License: apache-2.0
• Created: 2020-07-16T16:19:01.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-08T01:14:42.000Z (6 months ago)
• Last Synced: 2024-12-16T10:22:10.196Z (12 days ago)
• Topics: cli, conventional-commits, git, git-subcommand
• Language: Rust
• Homepage:
• Size: 288 KB
• Stars: 94
• Watchers: 1
• Forks: 7
• Open Issues: 27
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md
  • License: license-apache

Awesome Lists containing this project

README

        
# git-cm

> A git subcommand for creating conventional-friendly commit messages.

## Installation

Either compile from source or install via [crates.io](https://crates.io):

```console

$ cargo install git-cm --locked

```

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

```console

$ 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`:

```toml

[package.metadata.commits]

defaults = true

# This is optional

[[package.metadata.commits.type]]

name = "xyz"

desc = "A custom command"

```

## Example run

![Example run GIF](.github/git-cm.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.