diff --git a/docs/REVIEW.md b/docs/REVIEW.md index 4d997e2b..e052a668 100644 --- a/docs/REVIEW.md +++ b/docs/REVIEW.md @@ -49,7 +49,7 @@ This sub-tool checks if the PR description properly contains a ticket to a proje - `soc2_ticket_prompt`: The prompt for the SOC2 ticket review. Default is: `Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?`. Edit this field if your compliance requirements are different. #### Adding PR labels - `enable_review_labels_security`: if set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true. -- `enable_review_labels_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is false. +- `enable_review_labels_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true. ### Incremental Mode Incremental review only considers changes since the last PR-Agent review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again. @@ -103,7 +103,7 @@ The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the [Configuration options](#configuration-options) section, and choose the relevant options for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: -`require_score_review`, `require_soc2_ticket`, `enable_review_labels_effort`, and more. +`require_score_review`, `require_soc2_ticket`, and more. On the other hand, if you find one of the enabled features to be irrelevant for your use case, disable it. No default configuration can fit all use cases. diff --git a/pr_agent/servers/help.py b/pr_agent/servers/help.py index ce0da4e8..376475fe 100644 --- a/pr_agent/servers/help.py +++ b/pr_agent/servers/help.py @@ -95,7 +95,7 @@ The `review` tool can auto-generate two specific types of labels for a PR: The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: -`require_score_review`, `require_soc2_ticket`, `enable_review_labels_effort`, and more. +`require_score_review`, `require_soc2_ticket`, and more. """ output += "\n\n\n\n" diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml index 8c37ac8e..5d9a84ab 100644 --- a/pr_agent/settings/configuration.toml +++ b/pr_agent/settings/configuration.toml @@ -36,7 +36,7 @@ persistent_comment=true extra_instructions = "" # review labels enable_review_labels_security=true -enable_review_labels_effort=false +enable_review_labels_effort=true # specific configurations for incremental review (/review -i) require_all_thresholds_for_incremental_review=false minimal_commits_for_incremental_review=0