From e07412c098115e77ec8f39682eb7ef1f2bd5d76e Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 1 Oct 2023 09:00:58 +0300 Subject: [PATCH] prompt and readme updates --- README.md | 2 +- Usage.md | 25 ++++++++++------------ docs/TOOLS_GUIDE.md | 2 +- pr_agent/settings/pr_reviewer_prompts.toml | 3 +++ 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5f886e87..f3c8204a 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ See the [Release notes](./RELEASE_NOTES.md) for updates on the latest changes. | | Multiple models support | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Incremental PR Review | :white_check_mark: | | | | | | -Review the **[usage guide](./Usage.md)** section for detailed instructions how to use the different tools, select the relevant git provider (GitHub, Gitlab, Bitbucket,...), and adjust the configuration file to your needs. +Review the [usage guide](./Usage.md) section for detailed instructions how to use the different tools, select the relevant git provider (GitHub, Gitlab, Bitbucket,...), and adjust the configuration file to your needs. ## Try it now diff --git a/Usage.md b/Usage.md index 78bbe2ae..e5e5d638 100644 --- a/Usage.md +++ b/Usage.md @@ -11,15 +11,13 @@ ### Introduction -There are 3 basic ways to invoke CodiumAI PR-Agent: +See the **[installation guide](/INSTALL.md)** for instructions on how to setup PR-Agent. After installation, there are three basic ways to invoke CodiumAI PR-Agent: 1. Locally running a CLI command 2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR 3. Enabling PR-Agent tools to run automatically when a new PR is opened -See the **[installation guide](/INSTALL.md)** for instructions on how to setup your own PR-Agent. Specifically, CLI commands can be issued by invoking a pre-built [docker image](/INSTALL.md#running-from-source), or by invoking a [locally cloned repo](INSTALL.md#method-2-run-from-source). - For online usage, you will need to setup either a [GitHub App](INSTALL.md#method-5-run-as-a-github-app), or a [GitHub Action](INSTALL.md#method-3-run-as-a-github-action). GitHub App and GitHub Action also enable to run PR-Agent specific tool automatically when a new PR is opened. @@ -28,10 +26,12 @@ GitHub App and GitHub Action also enable to run PR-Agent specific tool automatic The different tools and sub-tools used by CodiumAI PR-Agent are adjustable via the **[configuration file](pr_agent/settings/configuration.toml)**. In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](/pr_agent/settings/configuration.toml#L16) section in the configuration file. -**git provider:** +The [Tools Guide](./docs/TOOLS_GUIDE.md) provides a detailed description of the different tools and their configurations. + +#### git provider The [git_provider](pr_agent/settings/configuration.toml#L4) field in the configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported: ` -"github", "gitlab", "azure", "codecommit", "local" +"github", "gitlab", "azure", "codecommit", "local", "gerrit" ` [//]: # (** online usage:**) @@ -48,7 +48,6 @@ The [git_provider](pr_agent/settings/configuration.toml#L4) field in the configu ### Working from a local repo (CLI) When running from your local repo (CLI), your local configuration file will be used. - Examples for invoking the different tools via the CLI: - **Review**: `python -m pr_agent.cli --pr_url= review` @@ -94,15 +93,15 @@ For example if you want to edit the `review` tool configurations, you can run: ``` /review --pr_reviewer.extra_instructions="..." --pr_reviewer.require_score_review=false ``` -Any configuration value in [configuration file](pr_agent/settings/configuration.toml) file can be similarly edited. +Any configuration value in [configuration file](pr_agent/settings/configuration.toml) file can be similarly edited. comment `/config` to see the list of available configurations. ### Working with GitHub App -When running PR-Agent from [GitHub App](INSTALL.md#method-5-run-as-a-github-app), the default configurations from a pre-built repo will be initially loaded. +When running PR-Agent from [GitHub App](INSTALL.md#method-5-run-as-a-github-app), the default configurations from a pre-built docker will be initially loaded. #### GitHub app automatic tools The [github_app](pr_agent/settings/configuration.toml#L56) section defines GitHub app specific configurations. -An important parameter is `pr_commands`, which is a list of tools that will be **run automatically when a new PR is opened**: +An important parameter is `pr_commands`, which is a list of tools that will be **run automatically** when a new PR is opened: ``` [github_app] pr_commands = [ @@ -113,7 +112,7 @@ pr_commands = [ This means that when a new PR is opened, PR-Agent will run the `describe` and `auto_review` tools. For the describe tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true. -However, you can override the default tool parameters by uploading a local configuration file called `.pr_agent.toml` to the root of your repo. +You can override the default tool parameters by uploading a local configuration file called `.pr_agent.toml` to the root of your repo. For example, if your local `.pr_agent.toml` file contains: ``` [pr_description] @@ -126,7 +125,6 @@ Note that a local `.pr_agent.toml` file enables you to edit and customize the de #### Editing the prompts The prompts for the various PR-Agent tools are defined in the `pr_agent/settings` folder. - In practice, the prompts are loaded and stored as a standard setting object. Hence, editing them is similar to editing any other configuration value - just place the relevant key in `.pr_agent.toml`file, and override the default value. @@ -156,13 +154,12 @@ You can configure settings in GitHub action by adding environment variables unde ``` specifically, `github_action.auto_review`, `github_action.auto_describe` and `github_action.auto_improve` are used to enable/disable automatic tools that run when a new PR is opened. -if not set, the default option is that only the `review` tool will run automatically when a new PR is opened. +If not set, the default option is that only the `review` tool will run automatically when a new PR is opened. ### Changing a model See [here](pr_agent/algo/__init__.py) for the list of available models. -To use a different model than the default (GPT-4), you need to edit [configuration file](pr_agent/settings/configuration.toml#L2) - +To use a different model than the default (GPT-4), you need to edit [configuration file](pr_agent/settings/configuration.toml#L2). For models and environments not from OPENAI, you might need to provide additional keys and other parameters. See below for instructions. #### Azure diff --git a/docs/TOOLS_GUIDE.md b/docs/TOOLS_GUIDE.md index 65e17ea9..352195bc 100644 --- a/docs/TOOLS_GUIDE.md +++ b/docs/TOOLS_GUIDE.md @@ -6,4 +6,4 @@ - [SIMILAR_ISSUE](./SIMILAR_ISSUE.md) - [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md) -See the **[installation guide](/INSTALL.md)** for instructions on how to setup your own PR-Agent. \ No newline at end of file +See the **[installation guide](/INSTALL.md)** for instructions on how to setup PR-Agent. \ No newline at end of file diff --git a/pr_agent/settings/pr_reviewer_prompts.toml b/pr_agent/settings/pr_reviewer_prompts.toml index c6a43e4b..c0599e50 100644 --- a/pr_agent/settings/pr_reviewer_prompts.toml +++ b/pr_agent/settings/pr_reviewer_prompts.toml @@ -151,6 +151,9 @@ PR Analysis: {%- if require_focused %} Focused PR: no, because ... {%- endif %} +{%- if require_estimate_effort_to_review %} + Estimated effort to review [1-5]: 3, because ... +{%- endif %} PR Feedback: General PR suggestions: |- ...