feat: Add custom labels and extra instructions sections to help.py, summarize mode to pr_code_suggestions.py, and summarize mode condition to pr_code_suggestions_prompts.toml

This commit is contained in:
mrT23
2024-01-09 22:09:48 +02:00
parent da3ac656ee
commit 9c6aabb0bb
3 changed files with 24 additions and 0 deletions

View File

@ -156,6 +156,7 @@ Note that when markers are enabled, if the original PR description does not cont
"""
output += "\n\n</details></td></tr>\n\n"
# custom labels
output += "<tr><td><details> <summary><strong> Custom labels </strong></summary><hr>\n\n"
output += """\
The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
@ -174,6 +175,25 @@ Make sure to provide proper title, and a detailed and well-phrased description f
"""
output += "\n\n</details></td></tr>\n\n"
# 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.
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.
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"
output += HelpMessage.get_general_bot_help_text()