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

review

Browse Source
This commit is contained in:
mrT23
2023-09-29 10:30:20 +03:00
parent e1149862b2
commit a371f7ab84
10 changed files with 48 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/DESCRIBE.md
View File

@ -15,7 +15,7 @@ The `describe` tool can also be triggered automatically every time a new PR is o
### Configuration options
Under the section 'pr_description', the [configuration file](./../pr_agent/settings/configuration.toml) contains options to customize the 'describe' tool:
Under the section 'pr_description', the [configuration file](./../pr_agent/settings/configuration.toml#L28) contains options to customize the 'describe' tool:
- `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true.

39
docs/REVIEW.md Normal file
View File

@ -0,0 +1,39 @@
# Describe Tool
The `review` tool scans the PR code changes, and automatically generates a PR review.
It can ba invoked manually by commenting on any PR:
```
/review
```
<img src=./../pics/review_comment.png width="768">
<img src=./../pics/describe.png width="768">
The `review` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
### Configuration options
Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings/configuration.toml#L16) contains options to customize the 'review' tool:
- `require_focused_review`: if set to true, the tool will add a section - 'is the PR a focused one'. Default is false.
- `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_security_review`: if set to true, the tool will add a section that checks if the PR contains security issues. Default is true.
- `require_estimate_effort_to_review`: if set to true, the tool will add a section that estimates thed effort needed to review the PR. Default is true.
- `num_code_suggestions`: number of code suggestions provided by the 'review' tool. Default is 4.
- `inline_code_comments`: if set to true, the tool will publish the code suggestions as comments on the code diff. Default is false.
- `automatic_review`: if set to false, no automatic reviews will be done. Default is true.
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
#### PR Reflection
By invoking:
```
/reflect_and_review
```
The module will first ask the author questions about the PR, and will guide the review based on his answers.
<img src=./../pics/reflection_questions.png width="768">
<img src=./../pics/reflection_answers.png width="768">
<img src=./../pics/reflection_insights.png width="768">

5
docs/SIMILAR_ISSUE.md
View File

@ -1,7 +1,8 @@
# Similar Issue Tool
The similar issue tool retrieves the most similar issues to the current issue:
The similar issue tool retrieves the most similar issues to the current issue.
It can ba invoked manually by commenting on any PR:
```
/similar issue
/similar_issue
```
<img src=./../pics/similar_issue_original_issue.png width="768">