added support for conventional commits
This commit is contained in:
12
README.md
12
README.md
@@ -17,13 +17,19 @@ Have AI Commit write your git commit messages for you so you never have to write
|
||||
|
||||
This project uses a command line interface tool called zx that's developed by google. In the script, it runs a `git diff` command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI. Fully privacy friendly as commands only run on your local machine using your OpenAI account.
|
||||
|
||||
Uses conventional commits by default. If you don't want this and want to return a full sentence with the commit message, set the conventionalCommit to false at the top of the script.
|
||||
|
||||
## Remaining tasks
|
||||
|
||||
- [x] Get a working first version with zx
|
||||
- [ ] pwd trick to get rid of /Users/hassan from the code
|
||||
- [ ] Add better error handling for missing git add . and commit msgs about a certain amount of chars
|
||||
- [x] pwd trick to get rid of /Users/hassan from the code
|
||||
- [x] Add better error handling for missing git add . and commit msgs about a certain amount of chars
|
||||
- [x] Add support for conventional commits by default
|
||||
- [ ] Figure out how to fail gracefully instead of exit 1
|
||||
- [ ] Go over other CLI repos to see what I can add
|
||||
- [ ] Test on Windows and Mac
|
||||
|
||||
- [ ] Try openai curie And/OR codex
|
||||
- [ ] Try supporting more than 200 lines by grabbing the diff per file
|
||||
- [ ] Add support for conventional commits
|
||||
- [ ] Rewrite this CLI tool using a Node framework and publish on npm to simplify the process
|
||||
- [ ] Build landing page w/ demo
|
||||
|
||||
Reference in New Issue
Block a user