Utilizing extra instructions\n\n" + output += '''\ +The `review` tool can be configured with extra instructions, which can be used 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. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. + +Examples for extra instructions: +``` +[pr_reviewer] # /review # +extra_instructions=""" +In the code feedback section, emphasize the following: +- Does the code logic cover relevant edge cases? +- Is the code logic clear and easy to understand? +- Is the code logic efficient? +... +""" +``` +Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. + ''' + output += "\n\n |
How to enable\\disable automation\n\n" + output += """\ +- When you first install PR-Agent app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the `review` tool is: +``` +pr_commands = ["/review", ...] +``` +meaning the `review` tool will run automatically on every PR, with the default configuration. +Edit this field to enable/disable the tool, or to change the used configurations + """ + output += "\n\n |
About the 'Code feedback' section\n\n" + output+="""\ +The `review` tool provides several type of feedbacks, one of them is code suggestions. +If you are interested **only** in the code suggestions, it is recommended to use the [`improve`](./IMPROVE.md) feature instead, since it dedicated only to code suggestions, and usually gives better results. +Use the `review` tool if you want to get a more comprehensive feedback, which includes code suggestions as well. +""" + output += "\n\n |
Auto-labels\n\n" + output+="""\ +The `review` tool can auto-generate two specific types of labels for a PR: +- a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag) +- a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag) +""" + output += "\n\n |
Extra sub-tools\n\n" + output += """\ +The `review` tool provides a collection of possible feedbacks about a PR. +It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), and choose the ones relevant for your use case. +Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: +`require_score_review`, `require_soc2_review`, `enable_review_labels_effort`, and more. +""" + output += "\n\n |
More PR-Agent commands\n\n" + output += HelpMessage.get_general_bot_help_text() + output += "\n\n |
Enabling\\disabling automation\n\n" + output += """\ +- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the describe tool is: +``` +pr_commands = ["/describe --pr_description.add_original_user_description=true" + "--pr_description.keep_original_user_title=true", ...] +``` +meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. + +- Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: +``` +pr_commands = ["/describe --pr_description.use_description_markers=true", ...] +``` +the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following: + - `type`: the PR type. + - `summary`: the PR summary. + - `walkthrough`: the PR walkthrough. + +Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all. + +""" + output += "\n\n |
Custom labels\n\n" + output += """\ +The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`]. + +If you specify [custom labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page or via configuration file, you can get tailored labels for your use cases. +Examples for custom labels: +- `Main topic:performance` - pr_agent:The main topic of this PR is performance +- `New endpoint` - pr_agent:A new endpoint was added in this PR +- `SQL query` - pr_agent:A new SQL query was added in this PR +- `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile +- ... + +The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. +Note that Labels are not mutually exclusive, so you can add multiple label categories. +Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it. +""" + output += "\n\n |
More PR-Agent commands\n\n" + output += HelpMessage.get_general_bot_help_text() + output += "\n\n |