Skip to content

Commit d8cf095

Browse files
chore(Cargo.toml): downgrade Rust edition to 2021
1 parent 42b266b commit d8cf095

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "git-cmt-rs"
33
version = "1.0.0"
4-
edition = "2024"
4+
edition = "2021"
55

66
[dependencies]
77
anyhow = "1.0"

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# git-cmt-rs
22

3-
An AI-powered Git commit message generator written in Rust that analyses your staged changes and creates [Conventional Commit](https://www.conventionalcommits.org/) messages using the OpenAI API.
3+
An AI-powered Git commit message generator written in Rust that automatically stages your changes and creates [Conventional Commit](https://www.conventionalcommits.org/) messages using the OpenAI API.
44

55
## Overview
66

7-
`git-cmt-rs` automatically generates meaningful commit messages based on your staged changes using OpenAIs chat completion models. It follows the Conventional Commits specification and provides an interactive commit experience.
7+
`git-cmt-rs` automatically stages all changes with `git add .`, analyzes the diff, and generates meaningful commit messages using OpenAI's chat completion models. It follows the Conventional Commits specification and provides an interactive commit experience with editor review.
88

99
Feel free to tweak the code to try different models, providers, or prompt templates. The implementation is simple and hackable.
1010

@@ -77,10 +77,10 @@ The tool automatically stages all changes with `git add .` before analyzing and
7777
## How it works
7878

7979
1. **Auto-staging**: Stages all changes with `git add .`
80-
2. **Diff Analysis**: Reads staged changes with `git diff --cached -b`
80+
2. **Diff Analysis**: Reads staged changes with `git diff --cached -b` (truncated to 3072 chars if necessary)
8181
3. **AI Processing**: Sends the diff to OpenAI with structured prompts and JSON schema enforcement
8282
4. **Message Generation**: Produces a commit object with `type`, `scope`, and `message`
83-
5. **Interactive Commit**: Opens your editor with the generated message
83+
5. **Interactive Commit**: Opens your editor with the generated message for review and editing
8484
6. **Final Commit**: Runs `git commit` with the approved message
8585

8686
## Commit Message Format

0 commit comments

Comments
 (0)