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

s

Browse Source
This commit is contained in:
mrT23
2024-01-06 10:08:29 +02:00
parent 82d10f24f0
commit a85a328791
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/DESCRIBE.md
View File

@ -123,9 +123,9 @@ the tool will replace every marker of the form `pr_agent:marker_name` in the PR
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. 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.
### Custom labels ### Custom labels
The default labels of the describe tool are quite generic, since they are meant to be used in any repo. The default labels are: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`]. The default labels of the describe tool are quite generic, since they are meant to be used in any repo: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
If you specify custom labels in the repo's labels page, you can get tailored labels for your repo and use cases. If you specify custom labels in the repo's labels page, you can get tailored labels for your use cases.
Examples for custom labels: Examples for custom labels:
- `Main topic:performence` - pr_agent:The main topic of this PR is performance - `Main topic:performence` - pr_agent:The main topic of this PR is performance
- `New endpoint` - pr_agent:A new endpoint was added in this PR - `New endpoint` - pr_agent:A new endpoint was added in this PR
@ -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 detailed 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.