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

feat: Refactor instructions and fields in pr_code_suggestions_prompts.toml

Browse Source
This commit is contained in:
mrT23
2024-01-09 22:49:26 +02:00
parent 2b607dbd9a
commit fc502a6fd5
2 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
pr_agent/servers/help.py
View File

@ -178,21 +178,22 @@ Make sure to provide proper title, and a detailed and well-phrased description f
# extra instructions
output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
output += '''\
The `describe` tool can be configured with extra instructions, which can be used to guide the model to a produce a description with the relevant content or style.
The `describe` tool can be configured with extra instructions, 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. Notice that the general structure of the description is already defined by the tool, and cannot be changed.
What you can change is the content content or style of each sub-section of the description.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
```
[pr_description]
extra_instructions="""
- the PR title should be in the format: '<PR type>: <PR summary>'
- ...
"""
```
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
'''
output += "\n\n</details></td></tr>\n\n"
Examples for extra instructions:
```
[pr_description]
extra_instructions="""
- the title section should be in the following format: <PR type>: <PR summary>
- ...
"""
```
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
'''
# general
output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"

2
pr_agent/settings/pr_description_prompts.toml
View File

@ -15,7 +15,7 @@ Your task is to provide a full description for the PR content - files walkthroug
Extra instructions from the user:
=====
{{ extra_instructions }}
{{extra_instructions}}
=====
{% endif %}