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

docs: Enhance 'improve' tool documentation and update 'DESCRIBE.md' with hyperlink

Browse Source
This commit is contained in:
mrT23
2024-01-07 11:19:47 +02:00
parent 94172104f0
commit d9872d7031
2 changed files with 50 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/DESCRIBE.md
View File

@ -128,7 +128,7 @@ Note that when markers are enabled, if the original PR description does not cont
### Custom labels
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 use cases.
If you specify [custom labels](#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page, you can get tailored labels for your use cases.
Examples for custom labels:
- `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
@ -138,4 +138,4 @@ Examples for custom labels:
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 detailed and well-phrased description for each label, so the tool will know when to suggest it.
<br>Make sure to provide proper title, and detailed and well-phrased description for each label, so the tool will know when to suggest it.