From eb798dae6f5f3242cf1f404fbb6dce4861df13b0 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 27 Jul 2023 08:13:21 +0300 Subject: [PATCH 1/4] Why use PR-Agent Why use PR-Agent --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 173b7844..744557d0 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull - [Usage and tools](#usage-and-tools) - [Configuration](./CONFIGURATION.md) - [How it works](#how-it-works) +- [Why use PR-Agent](#why-use-pr-agent) - [Roadmap](#roadmap) - [Similar projects](#similar-projects) @@ -146,6 +147,19 @@ There are several ways to use PR-Agent: Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how we convert a code diff to a manageable LLM prompt +## Why use PR-Agent? + +A reasonable question that can be asked is: `"Why use PR-Agent? What make it stand out from existing tools?"` + +Here are some of the reasons why: + +- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably. +- Our [PR Compression strategy](./PR_COMPRESSION.md) is a core ability that enables to effectively tackle both short and long PRs. +- Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the configuration file. Adding additional categories is easy and accessible. +- We support **multiple git providers** (GitHub, Gitlab, Bitbucket), and multiple ways to use the tool (CLI, GitHub Action, Docker, ...). +- We are open-source, and welcome contributions from the community. + + ## 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) From 231efb33c17bb2239a3562b83520c47cf29f60e4 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 27 Jul 2023 08:43:29 +0300 Subject: [PATCH 2/4] add CHANGELOG.md --- CHANGELOG.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..e69de29b From 66b94599ec99287cadaac061a85e8eefb16a278d Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 27 Jul 2023 08:45:33 +0300 Subject: [PATCH 3/4] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29b..8fb3cf2e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +## 2023-07-27 + +### Added +- New section 'Why use PR-Agent?' in README.md, providing reasons and justifications for using the PR-Agent tool. \ No newline at end of file From 48fcb46d4f3cdf4e898c5359f676bfb56041d686 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 27 Jul 2023 08:46:14 +0300 Subject: [PATCH 4/4] Delete CHANGELOG.md --- CHANGELOG.md | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 8fb3cf2e..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,4 +0,0 @@ -## 2023-07-27 - -### Added -- New section 'Why use PR-Agent?' in README.md, providing reasons and justifications for using the PR-Agent tool. \ No newline at end of file