From 677a54c5a07a836567707c30f3e5702318f19752 Mon Sep 17 00:00:00 2001 From: ofir-frd <85901822+ofir-frd@users.noreply.github.com> Date: Fri, 14 Mar 2025 12:02:26 +0200 Subject: [PATCH] Update review.md --- docs/docs/tools/review.md | 110 +++++++++++++++++++------------------- 1 file changed, 55 insertions(+), 55 deletions(-) diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index e3c3c3c6..37dfcc8e 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -51,68 +51,68 @@ extra_instructions = "..." !!! example "General options" - - - - - - - - - - - - - - - - - -
persistent_commentIf set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.
final_update_messageWhen set to true, updating a persistent review comment during online commenting will automatically add a short comment with a link to the updated review in the pull request .Default is true.
extra_instructionsOptional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
enable_help_textIf set to true, the tool will display a help text in the comment. Default is true.
+ + + + + + + + + + + + + + + + + +
persistent_commentIf set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.
final_update_messageWhen set to true, updating a persistent review comment during online commenting will automatically add a short comment with a link to the updated review in the pull request .Default is true.
extra_instructionsOptional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
enable_help_textIf set to true, the tool will display a help text in the comment. Default is true.
!!! example "Enable\\disable specific sub-sections" - - - - - - - - - - - - - - - - - - - - - - - - - -
require_score_reviewIf set to true, the tool will add a section that scores the PR. Default is false.
require_tests_reviewIf set to true, the tool will add a section that checks if the PR contains tests. Default is true.
require_estimate_effort_to_reviewIf set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.
require_can_be_split_reviewIf set to true, the tool will add a section that checks if the PR contains several themes, and can be split into smaller PRs. Default is false.
require_security_reviewIf set to true, the tool will add a section that checks if the PR contains a possible security or vulnerability issue. Default is true.
require_ticket_analysis_reviewIf set to true, and the PR contains a GitHub or Jira ticket link, the tool will add a section that checks if the PR in fact fulfilled the ticket requirements. Default is true.
+ + + + + + + + + + + + + + + + + + + + + + + + + +
require_score_reviewIf set to true, the tool will add a section that scores the PR. Default is false.
require_tests_reviewIf set to true, the tool will add a section that checks if the PR contains tests. Default is true.
require_estimate_effort_to_reviewIf set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.
require_can_be_split_reviewIf set to true, the tool will add a section that checks if the PR contains several themes, and can be split into smaller PRs. Default is false.
require_security_reviewIf set to true, the tool will add a section that checks if the PR contains a possible security or vulnerability issue. Default is true.
require_ticket_analysis_reviewIf set to true, and the PR contains a GitHub or Jira ticket link, the tool will add a section that checks if the PR in fact fulfilled the ticket requirements. Default is true.
!!! example "Adding PR labels" -You can enable\disable the `review` tool to add specific labels to the PR: + You can enable\disable the `review` tool to add specific labels to the PR: - - - - - - - - - -
enable_review_labels_securityIf set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.
enable_review_labels_effortIf set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.
+ + + + + + + + + +
enable_review_labels_securityIf set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.
enable_review_labels_effortIf set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.
## Usage Tips