From 4eff0282a199b865e78a5fba196d06ebec9e8e94 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 23 Nov 2023 08:06:07 +0200 Subject: [PATCH] Update Usage.md --- Usage.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/Usage.md b/Usage.md index bfb3ed17..f0b7071d 100644 --- a/Usage.md +++ b/Usage.md @@ -32,7 +32,7 @@ The [Tools Guide](./docs/TOOLS_GUIDE.md) provides a detailed description of the #### Ignoring files from analysis In some cases, you may want to exclude specific files or directories from the analysis performed by CodiumAI PR-Agent. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendored code. -To ignore files or directories, edit the **[ignore.toml](/pr_agent/settings/ignore.toml)** configuration file. This setting is also exposed the following environment variables: +To ignore files or directories, edit the **[ignore.toml](/pr_agent/settings/ignore.toml)** configuration file. This setting also exposes the following environment variables: - `IGNORE.GLOB` - `IGNORE.REGEX` @@ -61,7 +61,7 @@ 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: +Examples of invoking the different tools via the CLI: - **Review**: `python -m pr_agent.cli --pr_url= review` - **Describe**: `python -m pr_agent.cli --pr_url= describe` @@ -85,7 +85,7 @@ python -m pr_agent.cli --pr_url= /review --pr_reviewer.extra_instructio publish_output=true verbosity_level=2 ``` -This is useful for debugging or experimenting with the different tools. +This is useful for debugging or experimenting with different tools. ### Online usage @@ -102,17 +102,17 @@ Commands for invoking the different tools via comments: To edit a specific configuration value, just add `--config_path=` to any command. -For example if you want to edit the `review` tool configurations, you can run: +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. comment `/config` to see the list of available configurations. +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, the default [configuration file](pr_agent/settings/configuration.toml) from a pre-built docker will be initially loaded. -By uploading a local `.pr_agent.toml` file, you can edit and customize any configuration parameter. +By uploading a local `.pr_agent.toml` file to the root of the repo's main branch, you can edit and customize any configuration parameter. For example, if you set in `.pr_agent.toml`: @@ -121,7 +121,7 @@ For example, if you set in `.pr_agent.toml`: num_code_suggestions=1 ``` -Than you will overwrite the default number of code suggestions to be 1. +Then you will overwrite the default number of code suggestions to 1. #### GitHub app automatic tools The [github_app](pr_agent/settings/configuration.toml#L76) section defines GitHub app-specific configurations. @@ -135,7 +135,7 @@ The GitHub app can respond to the following actions on a PR: 4. `review_requested` - Specifically requesting review (in the PR reviewers list) from the `github-actions[bot]` user The configuration parameter `handle_pr_actions` defines the list of actions for which the GitHub app will trigger the PR-Agent. -The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when one of the above action happens (e.g. a new PR is opened): +The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when one of the above actions happens (e.g., a new PR is opened): ``` [github_app] handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested'] @@ -175,11 +175,11 @@ push_commands = [ "/auto_review -i --pr_reviewer.remove_previous_review_comment=true", ] ``` -The means that when new code is pushed to the PR, the PR-Agent will run the `describe` and incremental `auto_review` tools. +This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and incremental `auto_review` tools. For the describe tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true. For the `auto_review` tool, it will run in incremental mode, and the `remove_previous_review_comment` parameter will be set to true. -Much like the configurations for `pr_commands`, you can override the default tool paramteres by uploading a local configuration file to the root of your repo. +Much like the configurations for `pr_commands`, you can override the default tool parameters by uploading a local configuration file to the root of your repo. #### Editing the prompts The prompts for the various PR-Agent tools are defined in the `pr_agent/settings` folder.