xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-02 03:40:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add how it works section

Browse Source
This commit is contained in:
Hussam.lawen
2023-07-06 18:19:06 +03:00
parent d9bd73646c
commit c75f561701
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -14,6 +14,7 @@ It is powered by GPT-4, and is based on the [CodiumAI](https://github.com/Codium
* [Quickstart](#Quickstart)
* [Configuration](#Configuration)
* [Usage and Tools](#usage-and-tools)
* [How it works](#how-it-works)
* [Roadmap](#roadmap)
* [Similar projects](#similar-projects)
@ -148,8 +149,6 @@ CodiumAI PR-Agent provides two types of interactions ("tools"): `"PR Reviewer"`
- The "PR Reviewer" tool automatically analyzes PRs, and provides different types of feedbacks.
- The "PR Q&A" tool answers free-text questions about the PR.
![PR-Agent Tools](./pics/pr_agent_overview.png)
### PR Reviewer
Here is a quick overview of the different sub-tools of PR Reviewer:
@ -256,6 +255,11 @@ Example for extended suggestion:
```
---
## How it works
![PR-Agent Tools](./pics/pr_agent_overview.png)
Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how pr-agent works.
## Roadmap
- [ ] Support open-source models, as a replacement for openai models. Note that a minimal requirement for each open-source model is to have 8k+ context, and good support for generating json as an output