committer 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +29 -11
- data/lib/committer/version.rb +1 -1
- metadata +1 -3
- data/bin/git-smart-commit +0 -8
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 19704907042388baa2b8ede51ebe80710b9cbe5f6095fd09b0fb7cb997496382
|
|
4
|
+
data.tar.gz: ecaab24d0b58301c41a9677cf09fd1ae5ef23c3930c911c6cdf9820abacc52f9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1a6eb3eaabe0723082df95e113c7cbeb47521a16839ae04cdf6bfa146a3747b68b77aeac2462954220eeefd2cf709d73a8e2df9ab63b6b265d3c9f4304706357
|
|
7
|
+
data.tar.gz: 1c98170b2c2b194bb739c96278e3150e005d1f00df9c69c1c21219b26e7f2511d710894eb1001dfe973103e23efa22e91aabaa0f27fd06e53387aeca1b10e626
|
data/README.md
CHANGED
|
@@ -4,8 +4,25 @@ An AI-powered git commit message generator using Claude.
|
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
7
|
+
The goal of committer is to make it easier to write beautiful commits.
|
|
8
|
+
|
|
7
9
|
Committer uses Claude AI to analyze your staged git changes and generate conventional commit messages for you. It detects the type of changes (feature, fix, refactor, etc.) and creates a well-formatted commit message that follows best practices.
|
|
8
10
|
|
|
11
|
+
## What Makes a Good Commit
|
|
12
|
+
|
|
13
|
+
A good commit should:
|
|
14
|
+
- Have a summary that clearly describes the change
|
|
15
|
+
- Explain WHY the change was made, not just what changed
|
|
16
|
+
|
|
17
|
+
When a future developer uses git blame to understand a line of code, they should immediately understand why the change was made. This context is invaluable for maintaining and evolving the codebase effectively.
|
|
18
|
+
|
|
19
|
+
## How Committer Helps
|
|
20
|
+
|
|
21
|
+
Committer analyzes your code changes and generates commit messages that:
|
|
22
|
+
1. Provide a clean, descriptive summary of the change
|
|
23
|
+
2. Include context about why the change was necessary
|
|
24
|
+
3. Follow conventional commit format for consistency
|
|
25
|
+
|
|
9
26
|
## Installation
|
|
10
27
|
|
|
11
28
|
### Install from RubyGems
|
|
@@ -44,13 +61,19 @@ committer setup
|
|
|
44
61
|
|
|
45
62
|
This will create a template config file at `~/.committer/config.yml`.
|
|
46
63
|
|
|
47
|
-
Next, edit this file to add your Anthropic API key and optionally change the model:
|
|
64
|
+
Next, edit this file to add your Anthropic API key and optionally change the model or configure commit scopes:
|
|
48
65
|
|
|
49
66
|
```yaml
|
|
50
67
|
api_key: your_anthropic_api_key_here
|
|
51
68
|
model: claude-3-7-sonnet-20250219
|
|
69
|
+
scopes:
|
|
70
|
+
- feature
|
|
71
|
+
- api
|
|
72
|
+
- ui
|
|
52
73
|
```
|
|
53
74
|
|
|
75
|
+
The `scopes` configuration is optional. When provided, Committer will generate conventional commit messages with scopes (like `feat(api): add new endpoint`). If left as `null` or omitted, commit messages will be generated without scopes (like `feat: add new endpoint`).
|
|
76
|
+
|
|
54
77
|
You only need to do this setup once.
|
|
55
78
|
|
|
56
79
|
## Usage
|
|
@@ -64,10 +87,11 @@ committer
|
|
|
64
87
|
This will:
|
|
65
88
|
|
|
66
89
|
1. Get the diff of your staged changes
|
|
67
|
-
2.
|
|
68
|
-
3.
|
|
69
|
-
4.
|
|
70
|
-
5.
|
|
90
|
+
2. Ask you for optional context about why you're making the change
|
|
91
|
+
3. Send the diff and context to Claude for analysis
|
|
92
|
+
4. Generate a commit message in conventional format (with scope if configured)
|
|
93
|
+
5. Open your default git editor with the suggested message
|
|
94
|
+
6. Allow you to edit the message if needed or simply save to confirm
|
|
71
95
|
|
|
72
96
|
## Commands
|
|
73
97
|
|
|
@@ -75,12 +99,6 @@ This will:
|
|
|
75
99
|
- `committer setup` - Create the config file template
|
|
76
100
|
- `committer help` - Display help information
|
|
77
101
|
|
|
78
|
-
You can also run it directly through git:
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
git smart-commit
|
|
82
|
-
```
|
|
83
|
-
|
|
84
102
|
## License
|
|
85
103
|
|
|
86
104
|
MIT
|
data/lib/committer/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: committer
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Sebastien Stettler
|
|
@@ -29,14 +29,12 @@ description: A tool that uses Claude API to generate conventional commit message
|
|
|
29
29
|
email:
|
|
30
30
|
- sebastien@managerbot.dev
|
|
31
31
|
executables:
|
|
32
|
-
- git-smart-commit
|
|
33
32
|
- committer
|
|
34
33
|
extensions: []
|
|
35
34
|
extra_rdoc_files: []
|
|
36
35
|
files:
|
|
37
36
|
- README.md
|
|
38
37
|
- bin/committer
|
|
39
|
-
- bin/git-smart-commit
|
|
40
38
|
- lib/clients/claude_client.rb
|
|
41
39
|
- lib/committer/config.rb
|
|
42
40
|
- lib/committer/prompt_templates.rb
|