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

s

Browse Source
This commit is contained in:
mrT23
2024-01-07 17:02:18 +02:00
parent 578d15c6fc
commit a6bbd04efb
3 changed files with 19 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/IMPROVE.md
View File

@ -79,7 +79,7 @@ Examples for extra instructions:
[pr_code_suggestions] # /improve # [pr_code_suggestions] # /improve #
extra_instructions=""" extra_instructions="""
Emphasize the following aspects: Emphasize the following aspects:
- Does the code logic covers relevant edge cases? - Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand? - Is the code logic clear and easy to understand?
- Is the code logic efficient? - Is the code logic efficient?
... ...

6
docs/REVIEW.md
View File

@ -122,14 +122,14 @@ Edit this field to enable/disable the tool, or to change the used configurations
### Auto-labels ### Auto-labels
The `review` tool can auto-generate two specific types of labels for a PR: The `review` tool can auto-generate two specific types of labels for a PR:
- a `possible security issue` label if it detects a [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag) - a `possible security issue` label that detects a possible [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag)
- a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag) - a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
Both modes are useful, and we recommended to enable them. Both modes are useful, and we recommended to enable them.
### Extra instructions ### Extra instructions
Extra instruction are important. Extra instruction are important.
The `review` tool can be configured with extra instructions, which can be used to guide the model to feedback tailored to the needs of your project. The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
@ -138,7 +138,7 @@ Examples for extra instructions:
[pr_reviewer] # /review # [pr_reviewer] # /review #
extra_instructions=""" extra_instructions="""
In the code feedback section, emphasize the following: In the code feedback section, emphasize the following:
- Does the code logic covers relevant edge cases? - Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand? - Is the code logic clear and easy to understand?
- Is the code logic efficient? - Is the code logic efficient?
... ...

20
pr_agent/servers/help.py
View File

@ -34,7 +34,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen
# extra instructions # extra instructions
output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n" output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
output += '''\ output += '''\
The `review` tool can be configured with extra instructions, which can be used to guide the model to feedback tailored to the needs of your project. The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
@ -43,7 +43,7 @@ Examples for extra instructions:
[pr_reviewer] # /review # [pr_reviewer] # /review #
extra_instructions=""" extra_instructions="""
In the code feedback section, emphasize the following: In the code feedback section, emphasize the following:
- Does the code logic covers relevant edge cases? - Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand? - Is the code logic clear and easy to understand?
- Is the code logic efficient? - Is the code logic efficient?
... ...
@ -56,7 +56,7 @@ Use triple quotes to write multi-line instructions. Use bullet points to make th
# automation # automation
output += "<tr><td><details> <summary><strong> How to enable\\disable automation</strong></summary><hr>\n\n" output += "<tr><td><details> <summary><strong> How to enable\\disable automation</strong></summary><hr>\n\n"
output += """\ output += """\
- When you first install the github app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the `review` tool is: - When you first install PR-Agent app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the `review` tool is:
``` ```
pr_commands = ["/review", ...] pr_commands = ["/review", ...]
``` ```
@ -78,11 +78,21 @@ Use the `review` tool if you want to get a more comprehensive feedback, which in
output += "<tr><td><details> <summary><strong> Auto-labels</strong></summary><hr>\n\n" output += "<tr><td><details> <summary><strong> Auto-labels</strong></summary><hr>\n\n"
output+="""\ output+="""\
The `review` tool can auto-generate two specific types of labels for a PR: The `review` tool can auto-generate two specific types of labels for a PR:
- a `possible security issue` label, if it detects a [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag) - a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag)
- a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag) - a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
""" """
output += "\n\n</details></td></tr>\n\n" output += "\n\n</details></td></tr>\n\n"
# extra sub-tools
output += "<tr><td><details> <summary><strong> Extra sub-tools</strong></summary><hr>\n\n"
output += """\
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.
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_review`, `enable_review_labels_effort`, and more.
"""
output += "\n\n</details></td></tr>\n\n"
# general # general
output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n" output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
output += HelpMessage.get_general_bot_help_text() output += HelpMessage.get_general_bot_help_text()
@ -90,7 +100,7 @@ The `review` tool can auto-generate two specific types of labels for a PR:
output += "</table>" output += "</table>"
output += f"\n\nSee the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on all the available configurations.\n\n" output += f"\n\nSee the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on using this tool.\n\n"
return output return output