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

docs

Browse Source
This commit is contained in:
mrT23
2024-03-10 16:59:37 +02:00
parent 10a96d61ca
commit 4810b8549b
3 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -28,6 +28,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen
- `require_score_review`: if set to true, the tool will add a section that scores the PR. 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_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_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 can be split into smaller PRs. Default is false.
#### SOC2 ticket compliance 💎 #### SOC2 ticket compliance 💎
> This feature is available only in PR-Agent Pro > This feature is available only in PR-Agent Pro

2
pr_agent/servers/help.py
View File

@ -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. 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. 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: 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`, and more. `require_score_review`, `require_soc2_ticket`, `require_can_be_split_review`, and more.
""" """
output += "\n\n</details></td></tr>\n\n" output += "\n\n</details></td></tr>\n\n"

2
pr_agent/settings/pr_reviewer_prompts.toml
View File

@ -88,7 +88,7 @@ class PRReview(BaseModel):
code_feedback: List[CodeSuggestion] code_feedback: List[CodeSuggestion]
{%- else %} {%- else %}
class PRReview(BaseModel) class PRReview(BaseModel):
review: Review review: Review
{%- endif %} {%- endif %}
===== =====