From bd07a0cd7f10ae347eb63fb0e7e08c7e24d4e5ea Mon Sep 17 00:00:00 2001 From: mrT23 Date: Fri, 4 Aug 2023 12:13:04 +0300 Subject: [PATCH] Update Configuration.md --- CONFIGURATION.md | 26 ++++++++++++++++++++++++-- README.md | 17 ++++------------- 2 files changed, 28 insertions(+), 15 deletions(-) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 6aba8e51..4433e3ef 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -1,9 +1,31 @@ ## Configuration -The different tools and sub-tools used by CodiumAI pr-agent are adjustable via the configuration file: `/pr-agent/settings/configuration.toml`. +The different tools and sub-tools used by CodiumAI PR-Agent are adjustable via the configuration file: `/pr-agent/settings/configuration.toml`. + +### CLI +When running from source (CLI), your local configuration file will be used. + +Example for invoking the 'review' tools via the CLI: + +``` +python cli.py --pr-url= review +``` +In addition to general configurations, The 'review' tool will use parameters from the `[pr_reviewer]` section. Every tool has a dedicated section in the configuration file + +Note that you can print results locally, without publishing them, by setting in `configuration.toml`: + +``` +[config] +publish_output=true +verbosity_level=2 +``` +This is useful for debugging or experimenting with the different tools. + +### Working from pre-built repo (GitHub Action/GitHub App/Docker/...) +When running PR-Agent from a pre-built repo, the default configuration file will be loaded. To edit the configuration of any tool, just add `--config_path=` to you command. -For example if you want to edit online the `pr_reviewer` configurations, you can run: +For example if you want to edit online `pr_reviewer` configurations, you can run: ``` /review --pr_reviewer.extra_instructions="focus on the file xyz" --pr_reviewer.require_score_review=false ... ``` diff --git a/README.md b/README.md index 3488558e..a3b0f156 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,6 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull - [Overview](#overview) - [Try it now](#try-it-now) - [Installation](#installation) -- [Usage and tools](#usage-and-tools) - [Configuration](./CONFIGURATION.md) - [How it works](#how-it-works) - [Why use PR-Agent](#why-use-pr-agent) @@ -135,19 +134,11 @@ There are several ways to use PR-Agent: - [Method 5: Run as a GitHub App](INSTALL.md#method-5-run-as-a-github-app) - Allowing you to automate the review process on your private or public repositories -## Usage and Tools - -**PR-Agent** provides six types of interactions ("tools"): `"PR Reviewer"`, `"PR Q&A"`, `"PR Description"`, `"PR Code Sueggestions"`, `"PR Reflect and Review"` and `"PR Update Changlog"`. - -- The "PR Reviewer" tool automatically analyzes PRs, and provides various types of feedback. -- 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 initiates a dialog with the user, asks them to reflect on the PR, and then provides a more focused review. -- The "PR Update Changelog" tool automatically updates the CHANGELOG.md file with the PR changes. ## How it works +The following diagram illustrates PR-Agent tools and their flow: + ![PR-Agent Tools](https://www.codium.ai/wp-content/uploads/2023/07/codiumai-diagram-v4.jpg) 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 @@ -156,11 +147,11 @@ Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more detai 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: +Here are some advantages of PR-Agent: - 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. +- Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](./CONFIGURATION.md) 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, GitHub App, Docker, ...). - We are open-source, and welcome contributions from the community.