-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enhance README and update commit message hook logic (#19)
* Please set the OPENAI_API_KEY environment variable. Update readme * Fix check
- Loading branch information
Showing
2 changed files
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,25 @@ | ||
# ![GIT Hooks + OpenAI - Generate GIT commit messages from Open AI](docs/images/splash.png) | ||
|
||
🧠 🧰 This tool generates AI-powered commit messages via Git hooks, automating meaningful message suggestions from OpenAI and others to improve commit quality and efficiency. | ||
|
||
--- | ||
|
||
## What does I do | ||
|
||
Generates a commit message based on `git diff` result using the [OpenAI](https://platform.openai.com/docs/overview) API. | ||
|
||
--- | ||
|
||
## Getting started | ||
|
||
```ps | ||
dotnet tool install -g AiCommitMessage | ||
cd my-project/ | ||
dotnet-aicommitmessage install-hook | ||
``` | ||
|
||
1. Install the tool globally. | ||
2. Move to the project folder. | ||
3. Install the Git hook on the default `hooks` directory. | ||
|
||
--- |