From 12a7e1ce6ea7facccd2197209603e2e9c5bea33c Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 20 Jul 2023 12:09:58 +0300 Subject: [PATCH] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 29276d86..6b5a583a 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@
- - + +
@@ -14,9 +14,9 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR and can provide several types of feedback: -**Auto-Description**: Automatically generating PR description - name, type, summary, and code walkthrough. +**Auto-Description**: Automatically generating PR description - title, type, summary, code walkthrough and PR labels. \ -**PR Review**: Feedback about the PR main theme, type, relevant tests, security issues, focused PR, and various suggestions for the PR content. +**PR Review**: Adjustable feedback about the PR main theme, type, relevant tests, security issues, focus, score, and various suggestions for the PR content. \ **Question Answering**: Answering free-text questions about the PR. \ @@ -128,7 +128,7 @@ There are several ways to use PR-Agent: - The "PR Q&A" tool answers free-text questions about the PR. - The "PR Description" tool automatically sets the PR Title and body. - The "PR Code Suggestion" tool provide inline code suggestions for the PR that can be applied and committed. -- The "PR Reflect and Review" tool first initiates a dialog with the user and asks them to reflect on the PR, and then provides a review. +- The "PR Reflect and Review" tool initiates a dialog with the user, asks them to reflect on the PR, and then provides a more focused review. ## How it works @@ -138,9 +138,9 @@ Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more detai ## Roadmap -- [ ] Support open-source models, as a replacement for openai models. (Note - a minimal requirement for each open-source model is to have 8k+ context, and good support for generating json as an output) +- [ ] Support open-source models, as a replacement for OpenAI models. (Note - a minimal requirement for each open-source model is to have 8k+ context, and good support for generating JSON as an output) - [x] Support other Git providers, such as Gitlab and Bitbucket. -- [ ] Develop additional logics for handling large PRs, and compressing git patches +- [ ] Develop additional logic for handling large PRs, and compressing git patches - [ ] Add additional context to the prompt. For example, repo (or relevant files) summarization, with tools such a [ctags](https://github.com/universal-ctags/ctags) - [ ] Adding more tools. Possible directions: - [x] PR description