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

docs: Reorganize and enhance documentation for review and describe tools

Browse Source
This commit is contained in:
mrT23
2024-01-07 09:40:24 +02:00
parent d91f1fce09
commit 7810ba7d76
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/REVIEW.md
View File

@ -130,14 +130,14 @@ Be specific, clear, and concise in the instructions. With extra instructions, yo
Examples for extra instructions: Examples for extra instructions:
``` ```
pr_commands = ['/review --pr_reviewer.extra_instructions=""" [pr_reviewer] # /review #
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 covers 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?
... ...
"""\ """
']
``` ```
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.