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"
-
-
- require_score_review |
- If set to true, the tool will add a section that scores the PR. Default is false. |
-
-
- require_tests_review |
- If set to true, the tool will add a section that checks if the PR contains tests. Default is true. |
-
-
- require_estimate_effort_to_review |
- If 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_review |
- If 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_review |
- If 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_review |
- If 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_review |
+ If set to true, the tool will add a section that scores the PR. Default is false. |
+
+
+ require_tests_review |
+ If set to true, the tool will add a section that checks if the PR contains tests. Default is true. |
+
+
+ require_estimate_effort_to_review |
+ If 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_review |
+ If 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_review |
+ If 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_review |
+ If 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:
-