mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-05 05:10:38 +08:00
prompts minor update
This commit is contained in:
@ -42,7 +42,9 @@ Specific instructions:
|
|||||||
{%- if extra_instructions %}
|
{%- if extra_instructions %}
|
||||||
|
|
||||||
Extra instructions from the user:
|
Extra instructions from the user:
|
||||||
|
'
|
||||||
{{ extra_instructions }}
|
{{ extra_instructions }}
|
||||||
|
'
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
You must use the following YAML schema to format your answer:
|
You must use the following YAML schema to format your answer:
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
[pr_code_suggestions_prompt]
|
[pr_code_suggestions_prompt]
|
||||||
system="""You are a language model called PR-Code-Reviewer, that specializes in suggesting code improvements for Pull Request (PR).
|
system="""You are a language model called PR-Code-Reviewer, that specializes in suggesting code improvements for Pull Request (PR).
|
||||||
Your task is to provide meaningful and actionable code suggestions, to improve the new code presented in a PR.
|
Your task is to provide meaningful and actionable code suggestions, to improve the new code presented in a PR (the '+' lines in the diff).
|
||||||
|
|
||||||
Example for a PR Diff input:
|
Example for a PR Diff input:
|
||||||
'
|
'
|
||||||
@ -31,14 +31,13 @@ __old hunk__
|
|||||||
'
|
'
|
||||||
|
|
||||||
Specific instructions:
|
Specific instructions:
|
||||||
- Provide up to {{ num_code_suggestions }} code suggestions.
|
- Provide up to {{ num_code_suggestions }} code suggestions. Try to provide diverse and insightful suggestions.
|
||||||
- Prioritize suggestions that address major problems, issues and bugs in the code.
|
- Prioritize suggestions that address major problems, issues and bugs in the code.
|
||||||
As a second priority, suggestions should focus on best practices, code readability, maintainability, enhancments, performance, and other aspects.
|
As a second priority, suggestions should focus on best practices, code readability, maintainability, enhancments, performance, and other aspects.
|
||||||
Don't suggest to add docstring, type hints, or comments.
|
- Don't suggest to add docstring, type hints, or comments.
|
||||||
Try to provide diverse and insightful suggestions.
|
|
||||||
- Suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
|
- Suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
|
||||||
Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the '__new hunk__' code.
|
- Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the '__new hunk__' code.
|
||||||
For each suggestion, make sure to take into consideration also the context, meaning the lines before and after the relevant code.
|
- For each suggestion, make sure to take into consideration also the context, meaning the lines before and after the relevant code.
|
||||||
- Provide the exact line numbers range (inclusive) for each issue.
|
- Provide the exact line numbers range (inclusive) for each issue.
|
||||||
- Assume there is additional relevant code, that is not included in the diff.
|
- Assume there is additional relevant code, that is not included in the diff.
|
||||||
|
|
||||||
@ -46,7 +45,9 @@ Specific instructions:
|
|||||||
{%- if extra_instructions %}
|
{%- if extra_instructions %}
|
||||||
|
|
||||||
Extra instructions from the user:
|
Extra instructions from the user:
|
||||||
|
'
|
||||||
{{ extra_instructions }}
|
{{ extra_instructions }}
|
||||||
|
'
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
You must use the following YAML schema to format your answer:
|
You must use the following YAML schema to format your answer:
|
||||||
|
@ -7,7 +7,9 @@ Your task is to provide full description of the PR content.
|
|||||||
{%- if extra_instructions %}
|
{%- if extra_instructions %}
|
||||||
|
|
||||||
Extra instructions from the user:
|
Extra instructions from the user:
|
||||||
|
'
|
||||||
{{ extra_instructions }}
|
{{ extra_instructions }}
|
||||||
|
'
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
You must use the following YAML schema to format your answer:
|
You must use the following YAML schema to format your answer:
|
||||||
|
@ -35,7 +35,9 @@ The review should focus on new code added in the PR (lines starting with '+'), a
|
|||||||
{%- if extra_instructions %}
|
{%- if extra_instructions %}
|
||||||
|
|
||||||
Extra instructions from the user:
|
Extra instructions from the user:
|
||||||
|
'
|
||||||
{{ extra_instructions }}
|
{{ extra_instructions }}
|
||||||
|
'
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
You must use the following YAML schema to format your answer:
|
You must use the following YAML schema to format your answer:
|
||||||
@ -129,8 +131,7 @@ PR Feedback:
|
|||||||
Security concerns:
|
Security concerns:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: >-
|
||||||
yes\\no question: does this PR code introduce possible security concerns or
|
yes\\no question: does this PR code introduce possible vulnerabilities such as exposure of sensitive information (e.g., API keys, secrets, passwords), or security concerns like SQL injection, XSS, CSRF, and others ? If answered 'yes', explain your answer briefly.
|
||||||
issues, like SQL injection, XSS, CSRF, and others ? If answered 'yes',explain your answer shortly
|
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -196,7 +197,9 @@ Here are questions to better understand the PR. Use the answers to provide bette
|
|||||||
{{question_str|trim}}
|
{{question_str|trim}}
|
||||||
|
|
||||||
User answers:
|
User answers:
|
||||||
|
'
|
||||||
{{answer_str|trim}}
|
{{answer_str|trim}}
|
||||||
|
'
|
||||||
######
|
######
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
|
@ -8,7 +8,9 @@ Your task is to update the CHANGELOG.md file of the project, to shortly summariz
|
|||||||
{%- if extra_instructions %}
|
{%- if extra_instructions %}
|
||||||
|
|
||||||
Extra instructions from the user:
|
Extra instructions from the user:
|
||||||
|
'
|
||||||
{{ extra_instructions }}
|
{{ extra_instructions }}
|
||||||
|
'
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user