https://github.com/thomasvincent/commitkit-rust

A command-line tool writtenin Rust for creating conventional commit messages.
https://github.com/thomasvincent/commitkit-rust

Last synced: 11 days ago
JSON representation

A command-line tool writtenin Rust for creating conventional commit messages.

• Host: GitHub
• URL: https://github.com/thomasvincent/commitkit-rust
• Owner: thomasvincent
• License: mit
• Created: 2024-05-14T12:27:10.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-21T00:28:12.000Z (5 months ago)
• Last Synced: 2024-06-22T17:18:11.164Z (5 months ago)
• Language: Rust
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# # CommitKit-rust

[![Rust](https://img.shields.io/badge/Rust-1.x-orange)](https://www.rust-lang.org/)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

CommitKit is a command-line tool that helps developers create well-structured and consistent commit messages following the [Conventional Commits](https://www.conventionalcommits.org/) specification. It provides an interactive interface to guide users through the process of constructing a commit message with a prefix, optional scope, subject, body, and footer.

## Features

- Customizable prefixes and scopes through a configuration file (`.commitkit.toml`)

- Enforcement of a maximum length for the commit subject

- Support for multi-line commit body

- Optional footer for additional information

- Integration with git to execute the commit command

- Cross-platform compatibility (Windows, macOS, Linux)

## Installation

To install CommitKit, you need to have Rust installed on your system. If you don't have Rust installed, you can download and install it from the official Rust website: [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install)

Once Rust is installed, you can install CommitKit using Cargo, the Rust package manager:

```shell

cargo install commitkit

This will download and compile CommitKit, and install it in your system's PATH.

# Usage

To use CommitKit, navigate to your git repository in the terminal and run the following command:

### shell