From 2c1dfe7f3f7697c5b9f599ed866dd3840f90cdb5 Mon Sep 17 00:00:00 2001 From: Itamar Friedman <108689937+coditamar@users.noreply.github.com> Date: Mon, 11 Dec 2023 10:58:30 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a33fa7cf3..11700d323 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Making pull requests less painful with an AI agent
-CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull requests faster and more efficiently. It automatically analyzes the pull request and can provide several types of commands: +CodiumAI `PR-Agent` is an open-source tool aiming to help developers review and handle pull requests faster and more efficiently. It automatically analyzes the pull request and can provide several types of commands: ‣ **Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels. \ @@ -33,17 +33,17 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull \ ‣ **Update Changelog ([`/update_changelog`](./docs/UPDATE_CHANGELOG.md))**: Automatically updating the CHANGELOG.md file with the PR changes. \ -‣ **Find Similar Issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues +‣ **Find Similar Issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues. \ ‣ **Add Documentation ([`/add_docs`](./docs/ADD_DOCUMENTATION.md))**: Automatically adds documentation to un-documented functions/classes in the PR. \ ‣ **Generate Custom Labels ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes. -See the [Installation Guide](./INSTALL.md) for instructions how to install and run the tool on different platforms. +See the [Installation Guide](./INSTALL.md) for instructions how to install and run the tool on different git platforms. -See the [Usage Guide](./Usage.md) for instructions how to run the different tools from _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. +See the [Usage Guide](./Usage.md) for instructions how to run the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. -See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools. +See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools (tools are run via the commands).

Example results:

@@ -140,7 +140,7 @@ Review the [usage guide](./Usage.md) section for detailed instructions how to us ## Try it now -You can try GPT-4 powered PR-Agent, on your public GitHub repository, instantly. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. +You can try GPT-4 powered PR-Agent, on _your public GitHub repository_, instantly. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. For example, add a comment to any pull request with the following text: ``` @CodiumAI-Agent /review @@ -151,6 +151,7 @@ and the agent will respond with a review of your PR To set up your own PR-Agent, see the [Installation](#installation) section below. +Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, you do not need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. --- From 2ce4af16cb048c21e6aecec8b5f8f6f9baaef334 Mon Sep 17 00:00:00 2001 From: Itamar Friedman <108689937+coditamar@users.noreply.github.com> Date: Mon, 11 Dec 2023 11:10:27 +0200 Subject: [PATCH 2/3] Update README.md fix grammar according to PR-Agent suggestions --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 11700d323..95399c1e7 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Making pull requests less painful with an AI agent
-CodiumAI `PR-Agent` is an open-source tool aiming to help developers review and handle pull requests faster and more efficiently. It automatically analyzes the pull request and can provide several types of commands: +CodiumAI `PR-Agent` is an open-source tool for efficient pull request reviewing and handling. It automatically analyzes the pull request and can provide several types of commands: ‣ **Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels. \ @@ -41,7 +41,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review and See the [Installation Guide](./INSTALL.md) for instructions how to install and run the tool on different git platforms. -See the [Usage Guide](./Usage.md) for instructions how to run the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. +See the [Usage Guide](./Usage.md) for on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools (tools are run via the commands). @@ -140,7 +140,7 @@ Review the [usage guide](./Usage.md) section for detailed instructions how to us ## Try it now -You can try GPT-4 powered PR-Agent, on _your public GitHub repository_, instantly. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. +Try the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. For example, add a comment to any pull request with the following text: ``` @CodiumAI-Agent /review @@ -151,7 +151,7 @@ and the agent will respond with a review of your PR To set up your own PR-Agent, see the [Installation](#installation) section below. -Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, you do not need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. +Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. --- From e9bf8574a88609e810405e715d1205f95c2e1348 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Mon, 11 Dec 2023 11:52:36 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 95399c1e7..5de410b12 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@ CodiumAI `PR-Agent` is an open-source tool for efficient pull request reviewing \ ‣ **Generate Custom Labels ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes. -See the [Installation Guide](./INSTALL.md) for instructions how to install and run the tool on different git platforms. +See the [Installation Guide](./INSTALL.md) for instructions on installing and running the tool on different git platforms. -See the [Usage Guide](./Usage.md) for on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. +See the [Usage Guide](./Usage.md) for running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools (tools are run via the commands).