xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-04 04:40:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update review.md

Browse Source
This commit is contained in:
ofir-frd
2025-03-14 12:02:26 +02:00
committed by GitHub
parent a211175fea
commit 677a54c5a0
1 changed files with 55 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
docs/docs/tools/review.md
View File

@ -51,68 +51,68 @@ extra_instructions = "..."
!!! example "General options" !!! example "General options"
<table> <table>
<tr> <tr>
<td><b>persistent_comment</b></td> <td><b>persistent_comment</b></td>
<td>If set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.</td> <td>If set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.</td>
</tr> </tr>
<tr> <tr>
<td><b>final_update_message</b></td> <td><b>final_update_message</b></td>
<td>When 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.</td> <td>When 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.</td>
</tr> </tr>
<tr> <tr>
<td><b>extra_instructions</b></td> <td><b>extra_instructions</b></td>
<td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".</td> <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".</td>
</tr> </tr>
<tr> <tr>
<td><b>enable_help_text</b></td> <td><b>enable_help_text</b></td>
<td>If set to true, the tool will display a help text in the comment. Default is true.</td> <td>If set to true, the tool will display a help text in the comment. Default is true.</td>
</tr> </tr>
</table> </table>
!!! example "Enable\\disable specific sub-sections" !!! example "Enable\\disable specific sub-sections"
<table> <table>
<tr> <tr>
<td><b>require_score_review</b></td> <td><b>require_score_review</b></td>
<td>If set to true, the tool will add a section that scores the PR. Default is false.</td> <td>If set to true, the tool will add a section that scores the PR. Default is false.</td>
</tr> </tr>
<tr> <tr>
<td><b>require_tests_review</b></td> <td><b>require_tests_review</b></td>
<td>If set to true, the tool will add a section that checks if the PR contains tests. Default is true.</td> <td>If set to true, the tool will add a section that checks if the PR contains tests. Default is true.</td>
</tr> </tr>
<tr> <tr>
<td><b>require_estimate_effort_to_review</b></td> <td><b>require_estimate_effort_to_review</b></td>
<td>If set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.</td> <td>If set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.</td>
</tr> </tr>
<tr> <tr>
<td><b>require_can_be_split_review</b></td> <td><b>require_can_be_split_review</b></td>
<td>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.</td> <td>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.</td>
</tr> </tr>
<tr> <tr>
<td><b>require_security_review</b></td> <td><b>require_security_review</b></td>
<td>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.</td> <td>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.</td>
</tr> </tr>
<tr> <tr>
<td><b>require_ticket_analysis_review</b></td> <td><b>require_ticket_analysis_review</b></td>
<td>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.</td> <td>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.</td>
</tr> </tr>
</table> </table>
!!! example "Adding PR labels" !!! 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:
<table> <table>
<tr> <tr>
<td><b>enable_review_labels_security</b></td> <td><b>enable_review_labels_security</b></td>
<td>If set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.</td> <td>If set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.</td>
</tr> </tr>
<tr> <tr>
<td><b>enable_review_labels_effort</b></td> <td><b>enable_review_labels_effort</b></td>
<td>If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.</td> <td>If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.</td>
</tr> </tr>
</table> </table>
## Usage Tips ## Usage Tips