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

Update DESCRIBE.md

Browse Source
This commit is contained in:
Tal
2024-01-06 21:46:11 +02:00
committed by GitHub
parent 19e38595f3
commit 6d359fe1d8
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/DESCRIBE.md
View File

@ -100,20 +100,20 @@ The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary`
### Automation ### Automation
- 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: - 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_commands = ["/describe --pr_description.add_original_user_description=true"
--pr_description.keep_original_user_title=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. <br> This default is quite conservative, and strikes a good balance between automation and control: 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. <br> This default is quite conservative, and strikes a good balance between automation and control:
If you want more automation, just give the PR a title, and the tool will auto-write a full description; If you want more control, you can add a detailed description, and the tool will add the complementary description below it. If you want more automation, just give the PR a title, and the tool will auto-write a full description; If you want more control, you can add a detailed description, and the tool will add the complementary description below it.
- For maximal automation, you can change the default mode to: - For maximal automation, you can change the default mode to:
``` ```
pr_commands = ["describe --pr_description.add_original_user_description=false pr_commands = ["/describe --pr_description.add_original_user_description=false"
--pr_description.keep_original_user_title=true", ...] "--pr_description.keep_original_user_title=true", ...]
``` ```
so the title will be auto-generated as well. so the title will be auto-generated as well.
- Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: - 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", ...] 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: 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. - `type`: the PR type.
@ -135,4 +135,4 @@ Examples for custom labels:
The list above is eclectic, and aims to give an idea of different possibilities. Define the custom labels that are relevant for your repo and use cases. The list above is eclectic, and aims to give an idea of different possibilities. Define the 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. Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and detailed and well-phrased description for each label, so the tool will know when to suggest it. Make sure to provide proper title, and detailed and well-phrased description for each label, so the tool will know when to suggest it.