diff --git a/README.md b/README.md index f01bcc3d..3c592dd1 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Making pull requests less painful with an AI agent ## News and Updates ### Feb 6, 2024 -A new feature was added to the `review` tool - [Auto-approved PRs](./docs/REVIEW.md#auto-approved-prs). If enabled, this feature enables to automatically approve PRs that meet specific criteria, by commenting on a PR: `/review auto_approve`. +A new feature was added to the `review` tool - [Auto-approve PRs](./docs/REVIEW.md#auto-approval-1). If enabled, this feature enables to automatically approve PRs that meet specific criteria, by commenting on a PR: `/review auto_approve`. ### Feb 2, 2024 We are excited to introduce "PR Actions" 💎: diff --git a/docs/REVIEW.md b/docs/REVIEW.md index e37b9c24..0c22f280 100644 --- a/docs/REVIEW.md +++ b/docs/REVIEW.md @@ -11,7 +11,7 @@ - [Automation](#automation) - [Auto-labels](#auto-labels) - [Extra instructions](#extra-instructions) - - [Auto-approval](#auto-approval) + - [Auto-approval](#auto-approval-1) ## Overview The `review` tool scans the PR code changes, and automatically generates a PR review. @@ -153,7 +153,7 @@ Use triple quotes to write multi-line instructions. Use bullet points to make th ### Auto-approval -PR-Agent can approve a PR when a specific comment is invoked, given that this ability was enabled in the configuration file. +PR-Agent can approve a PR when a specific comment is invoked. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: ``` @@ -170,7 +170,7 @@ After enabling, by invoking: The tool will automatically approve the PR, and add a comment with the approval. -You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: +You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` label is equal or below a certain threshold, by adjusting the flag: ``` [pr_reviewer] maximal_review_effort = 5