Skip to content

Commit d708125

Browse files
Richard VanbergenRichard Vanbergen
authored andcommitted
Add MIT license and project documentation
The initial project setup includes basic usage instructions and adds the MIT license to ensure clear terms of use. The README outlines installation steps and explains how to use the git-commit-ai extension for automated commit message generation.
1 parent 2aef699 commit d708125

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

LICENCE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2025 Richard Vanbergen
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
11
# go-commit-ai
2+
3+
Proof of concept right now. This is a git extension that will look at your staged files and analyse the changes within. It will then attempt to write a good commit message for you. You will have a chance to edit it.
4+
5+
Currently requires an Anthropic API key, I plan to add a few other adapters. This was literally hacked together in about 2 hours so don't expect miracles.
6+
7+
## Instructions
8+
9+
Download the binary from GitHub or you can compile yourself using:
10+
11+
```
12+
go build -o git-commit-ai
13+
```
14+
15+
Once you have a binary you can simply put it somewhere in your `PATH`. Stage some files in git and then run:
16+
17+
```
18+
git commit-ai
19+
```
20+
21+
It should open in your default editor with a commit message pre-populated. You can edit it and then save and quit. The temporary commit file will be deleted and you'll be asked to confirm one more time, then it'll automatically commit with that message.

0 commit comments

Comments
 (0)