Skip to content

Commit 3f87396

Browse files
committed
Update README.md to enhance descriptions of AICodeBot features
This commit updates the README.md file to provide more detailed and engaging descriptions of the AICodeBot features. The changes aim to better explain the benefits and functionality of the AI-Assisted Git Commit, AI-Assisted Code Review, and AI-Assisted Debugging features. The goal is to provide users with a clearer understanding of how these features can enhance their coding experience and productivity.
1 parent 08a88f2 commit 3f87396

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ It's also not a "build a site for me in 5 minutes" tool that takes a well constr
2222

2323
### AI-Assisted Git Commit
2424

25-
`aicodebot commit` will run pre-commit for you to check syntax, and then generate a commit message for you based on the changes you've made. It will also commit the changes for you once everything checks out.
25+
`aicodebot commit` will run pre-commit for you to check syntax, and then generate a commit message for you based on the changes you've made. In about as much effort as typing "fix bug" for the commit message, you will get a high quality commit message that describes the change. It will also commit the changes for you once everything checks out.
2626

2727
### AI-Assisted Code Review
2828

29-
`aicodebot review` will run a code review on your code and suggest improvements. By default it will look at [un]staged changes, and you can also supply a specific commit hash to review. It also suggests best practices for code improvement.
29+
`aicodebot review` will run a code review on your code and suggest improvements. By default it will look at [un]staged changes, and you can also supply a specific commit hash to review. It's goal is to suggest how to make the code better, and we've found that it often teaches us new things about our code. It's not perfect, but it's a great way to get a second set of robot eyes on your code.
3030

3131
### AI-Assisted Debugging
3232

33-
`aicodebot debug $command` will run the command and capture the log message. It will then try to figure out what's going on from the error message and suggest a fix.
33+
`aicodebot debug $command` will run the command and capture the log message. It will pass the error message, stack trace, comand output, etc. to the AI and respond with some suggestions on how to fix it. It saves a trip to stackoverflow in a separate window, allowing you to stay in terminal with all the context.
3434

3535
### AI-Assisted Code Creation (Work in Progress)
3636

0 commit comments

Comments
 (0)