Testing typo detection - Githubissues

^{This message was generated by git-bob (version: 0.5.0, model: gpt-4o-2024-08-06), an experimental AI-based assistant. It can make mistakes and has limitations. Check its messages carefully.}

Thank you for bringing this to my attention. Here's a proposed update to fix potential typos in readme.md:

# git-bob

git-bob uses AI to solve GitHub issues and review pull requests. It runs inside GitHub CI, so there's no need to install anything on your computer.

![demo_fix_typos.png](docs/images/banner.png)

Under the hood, it uses [Anthropic's Claude](https://www.anthropic.com/api) or [OpenAI's ChatGPT](https://openai.com/blog/openai-api) <!--or [Google's Gemini](https://blog.google/technology/ai/google-gemini-ai/)--> to understand the text and [pygithub](https://github.com/PyGithub/PyGithub) to interact with the issues and pull requests.

## Disclaimer

`git-bob` is a research project aiming to streamline GitHub interaction in software development projects. Under the hood, it uses artificial intelligence/large language models to generate text and code fulfilling the user's requests. Users are responsible for verifying the generated code according to good scientific practice.

When using `git-bob`, you configure it to use an API key to access the AI models. You have to pay for the usage and must be careful in using the software. Do not use this technology if you are not aware of the costs and consequences.

> [!CAUTION]
> When using Anthropic, OpenAI <!--, Google Gemini--> or any other endpoint via git-bob, you are bound to the terms of service of the respective companies or organizations.
> The GitHub issues, pull requests, and messages you enter are transferred to their servers and may be processed and stored there. Make sure not to submit any sensitive, confidential, or personal data. Also, using these services may cost money.

## Installation as GitHub action

There is a detailed [tutorial](docs/installation-tutorial.md) on how to install git-bob as a GitHub action in your repository. In very short, to use git-bob in your GitHub repository, you need to:
* Copy the [git-bob](.github/workflows/git-bob.yml) GitHub workflow in the folder `.github/workflows/` to your repository.
  * Make sure to replace `pip install -e .` with a specific git-bob version such as `pip install git-bob==0.4.0`.
  * Configure the LLM you want to use in the workflow files by specifying the `GIT_BOB_LLM_NAME` environment variable. These were tested:
* `claude-3-5-sonnet-20240620`
* `gpt-4o-2024-08-06` (recommended if you work with large files, < 16k tokens)
* `github_models:gpt-4o`
* `github_models:meta-llama-3.1-405b-instruct`
<!--* `gemini-1.5-flash-001`-->
* Configure a GitHub secret called `OPENAI_API_KEY` or `ANTHROPIC_API_KEY` or `GH_MODELS_API_KEY` <!--or `GOOGLE_API_KEY`--> with the corresponding key from the LLM provider depending on the above configured LLM. You can get these keys here:
  * [OpenAI (gpt)](https://openai.com/blog/openai-api)
  * [Anthropic (claude)](https://www.anthropic.com/api)
  * [GitHub Models Marketplace](https://github.com/marketplace/models)
  <!-- * [Google AI](https://ai.google.dev/gemini-api/docs/api-key)-->
* Configure GitHub actions to run the workflow on issues and pull requests. Also, give write access to the Workflow using the `GITHUB_TOKEN`.

To trigger git-bob, you need to comment on an issue or pull request with the following command:

git-bob comment


If the issue is complex and should be split into sub-issues, you can use the following command:

git-bob split


You can also use the following command to trigger git-bob solving an issue.
It will then try to solve the issue and send a pull request.
This action can also be used to modify the code in pull requests.

git-bob solve


## Recommended Workflow

Here's the recommended workflow for using git-bob:

1. Create an issue describing the problem or task.
2. Comment on the issue with `git-bob comment`, or `git-bob think about this` (an alias for `comment`) to trigger git-bob to make a plan.
3. Respond to git-bob with any clarifications or additional information it requests.
4. Comment on the issue with `git-bob solve` or `git-bob implement this` (an alias for `solve`) to trigger git-bob.
5. Wait for git-bob to create a pull request (PR) addressing the issue.
6. Review the PR and comment on the PR or on the original issue if changes are needed.
7. Wait for git-bob to create a new PR or modify the existing PR with the requested changes.
8. Repeat steps 3-5 as necessary until the issue is resolved satisfactorily.

## Use-case examples

### Solving GitHub issues

`git-bob` can fix typos ([issue](https://github.com/haesleinhuepf/git-bob/issues/16), [pull request](https://github.com/haesleinhuepf/git-bob/pull/17)):

<a href="docs/images/demo_fix_typos.png"><img src="docs/images/demo_fix_typos.png" width="400"></a>

`git-bob` can improve code documentation ([issue](https://github.com/haesleinhuepf/git-bob/issues/19), [pull request](https://github.com/haesleinhuepf/git-bob/pull/21)):

<a href="docs/images/demo_comment_code.png"><img src="docs/images/demo_comment_code.png" width="400"></a>

### Review Pull Requests
`git-bob` can review pull requests and provide feedback ([pull request](https://github.com/haesleinhuepf/git-bob/pull/11)):

<a href="docs/images/demo_review_pull_request.png"><img src="docs/images/demo_review_pull_request.png" width="400"></a>

### Splitting Issues

To split a main issue into sub-issues, ask `git-bob split this issue`.

### General prompting
`git-bob` can also be exploited to answer questions ([issue](https://github.com/haesleinhuepf/git-bob/issues/20)).

<a href="docs/images/demo_question.png"><img src="docs/images/demo_question.png" width="400"></a>

## Installation for development

git clone https://github.com/haselinhuepf/git-bob.git cd git-bob


### Installation as a command-line tool (for development)

You can also install git-bob locally and run it from the terminal. 
In this case, create a [GitHub token](https://github.com/settings/tokens) and store it in an environment variable named `GITHUB_API_KEY`. 
Also, create an environment variable `GIT_BOB_LLM_NAME` with the name of the LLM you want to use, e.g., "gpt-4o-2024-05-13" or "claude-3-5-sonnet-20240620" or "github_models:gpt-4o".
Then you can install git-bob using pip:

```bash
pip install git-bob

Usage as a command-line tool (for development)

You can then use git-bob from the terminal on repositories you have read/write access to. It is recommended to call it from the root folder of the repository you want to interact with.

git clone https://github.com/<organization>/<repository>
cd <repository>
git-bob <action> <organization>/<repository> <issue-number>

Available actions:

review-pull-request
comment-on-issue
solve-issue
split-issue

Limitations

git-bob is a research project and has limitations. It serves as a basis for discussion and further development. Once LLMs become better, git-bob will become better as well.

At the moment, these limitations can be observed:

git-bob was tested for Python projects mostly. It seems to be able to process Java and C++ as well.
It cannot solve issues where running and testing the code is required.
It sometimes hallucinates, especially in code reviews. For example, it claimed to have tested code, which is certainly not true.
It cannot solve issues where changing long files is required, as the output of the LLMs is limited by a maximum number of tokens (e.g., 16k for gpt-4o-2024-08-06). When using OpenAI's models, it combines output from multiple requests to a maximum file length of about 64k tokens. It may then miss some spaces or a line break where responses were stitched. When using GitHub models, the maximum file length is 4k tokens. When using Anthropic's Claude, the maximum file length is 8k tokens.
When changing multiple files, it may introduce conflicts between the files, as it does not know the changed contents of the other files.
It has limited logic to control who is allowed to trigger it. If you are a repository member, you can trigger it. If others send a pull request, a repository member must allow the action to run manually.
git-bob is incompatible with locally running open-source/-weight LLMs. This might make sense when being executed locally only. In the GitHub-CI, this might be impossible.
Recently tested claude-3-5-sonnet-20240620, gpt-4o-2024-08-06, github_models:gpt-4o, and github_models:meta-llama-3.1-405b-instruct models produce useful results. The model gemini-1.5-flash-001 is technically supported too, but its results were not very useful.

Similar projects

There are similar projects out there

Contributing

Feedback and contributions are welcome! Just open an issue, and let's discuss it before you send a pull request. A human will respond and comment on your ideas!

Acknowledgements

We acknowledge the financial support of the Federal Ministry of Education and Research of Germany and by Sächsische Staatsministerium für Wissenschaft, Kultur und Tourismus in the programme Center of Excellence for AI-research „Center for Scalable Data Analytics and Artificial Intelligence Dresden/Leipzig", project identification number: ScaDS.AI



Let me know if there's anything else you need!

haesleinhuepf / git-bob

Testing typo detection #292

Usage as a command-line tool (for development)

Limitations

Similar projects

Contributing

Acknowledgements