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

readme

Browse Source
This commit is contained in:
mrT23
2024-04-07 16:28:30 +03:00
parent 68f29a41ef
commit aa2121a48d
4 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/tools/improve.md
View File

@ -72,7 +72,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen
Examples for extra instructions: 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 cover 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?

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

@ -124,8 +124,8 @@ The tool will first ask the author questions about the PR, and will guide the re
Examples for extra instructions: Examples for extra instructions:
``` ```
[pr_reviewer] # /review # [pr_reviewer]
extra_instructions=""" extra_instructions="""\
In the code feedback section, emphasize the following: In the code feedback section, emphasize the following:
- Does the code logic cover 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?

2
docs/docs/usage-guide/configuration_options.md
View File

@ -22,7 +22,7 @@ Click [here](https://codium.ai/images/pr_agent/wiki_configuration_pr_agent.mp4)
An example content: An example content:
``` ```
[pr_description] # /describe # [pr_description]
keep_original_user_title=false keep_original_user_title=false
``` ```

2
pr_agent/servers/help.py
View File

@ -128,7 +128,7 @@ Be specific, clear, and concise in the instructions. With extra instructions, yo
Examples for extra instructions: Examples for extra instructions:
``` ```
[pr_description] [pr_description]
extra_instructions=""" extra_instructions="""\
- The PR title should be in the format: '<PR type>: <title>' - The PR title should be in the format: '<PR type>: <title>'
- The title should be short and concise (up to 10 words) - The title should be short and concise (up to 10 words)
- ... - ...