Skip to content

Commit 01ab8c0

Browse files
committed
Update README with more info on sidekick
1 parent 26dca3b commit 01ab8c0

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ In this example, the sidekick will read in the contents of file1.py and file2.py
3232

3333
* How can I make this code better?
3434
* Tell me how to add a new feature to this code.
35-
* Fix an issue that I'm having when... (describe the issue)
35+
* Fix an issue that I'm having... (paste the error, stack trace, etc)
3636
* Write unit tests for the xyz function.
3737

3838
Please note that this feature is still in its experimental stage. While it can already provide valuable assistance, it's not perfect and we're continuously working on improving it.
@@ -47,7 +47,7 @@ Please note that this feature is still in its experimental stage. While it can a
4747

4848
### AI-Assisted Debugging
4949

50-
`aicodebot debug $command` will run the command and capture the log message. It will pass the error message, stack trace, command 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.
50+
`aicodebot debug $command` will run the command and capture the log message. It will pass the error message, stack trace, command output, etc. to the AI and respond with some suggestions on how to fix it. It saves a trip to Stack Overflow in a separate window, allowing you to stay in terminal with all the context.
5151

5252
[![PyPI version](https://badge.fury.io/py/aicodebot.svg?0.6.2)](https://badge.fury.io/py/aicodebot)
5353

@@ -72,6 +72,7 @@ Commands:
7272
debug Run a command and debug the output.
7373
fun-fact Get a fun fact about programming and artificial intelligence.
7474
review Do a code review, with [un]staged changes, or a specified...
75+
sidekick EXPERIMENTAL: Coding help from your AI sidekick
7576
```
7677

7778
### Open AI key setup
@@ -116,7 +117,7 @@ Note: We'll be adding more options for AI models in the future, including those
116117
### Repository / Project Management
117118

118119
* [ ] **Project best practices**: Suggest things like pre-commit, linting, license, CI/CD, etc. Eventually: Implement them for you.
119-
* [ ] **Manage Github Issues**: Provides Level 1 triage of incoming issues on GitHub, including tagging, assigning, and responding with FAQs. It could also escalate issues to human developers when necessary, and provide nudges for tasks that need more input.
120+
* [ ] **Manage GitHub Issues**: Provides Level 1 triage of incoming issues on GitHub, including tagging, assigning, and responding with FAQs. It could also escalate issues to human developers when necessary, and provide nudges for tasks that need more input.
120121
* [ ] **Welcome new contributors**: Automatically welcome new contributors to the project, find out what they're interested in, and suggest issues for them to work on.
121122

122123
### Fun

0 commit comments

Comments
 (0)