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

Add to describe

Browse Source
This commit is contained in:
Hussam.lawen
2023-12-18 10:08:29 +02:00
parent 3b13738943
commit f121a420c9
2 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/DESCRIBE.md
View File

@ -13,6 +13,20 @@ For example:
The `describe` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
### Git provider's native labels page
> This feature is available only in Pr-Agent Pro :gem:
* Github : https://github.com/{owner}/{repo}/labels, or click on the "Labels" tab in the issues or PRs page.
* GitLab : https://gitlab.com/{owner}/{repo}/-/labels, or click on "Manage" -> "Labels" on the left menu.
b. Add/edit the custom labels. It should be formatted as follows:
* Label name: The name of the custom label.
* Description: Description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.
<kbd><img src=https://codium.ai/images/pr_agent/add_native_custom_labels.png width="768"></kbd>
c. Now the custom labels will be included in the `generate_labels` tool.
*This feature is supported in GitHub and GitLab.
### Configuration options
Under the section 'pr_description', the [configuration file](./../pr_agent/settings/configuration.toml#L28) contains options to customize the 'describe' tool:

3
docs/GENERATE_CUSTOM_LABELS.md
View File

@ -24,7 +24,8 @@ To enable custom labels, you need to apply the [configuration changes](#configur
#### 2. GitHub Action and GitHub App
To enable custom labels, you need to apply the [configuration changes](#configuration-changes) to the local `.pr_agent.toml` file in you repository.
#### 3. Git provider's native labels page (Pr-Agent Pro feature :gem:)
#### 3. Git provider's native labels page
> This feature is available only in Pr-Agent Pro :gem:
To enable custom labels, you can add/edit the custom labels in the Git provider's native labels page. For example, in GitHub, you can add/edit the labels in the Labels page:
a. Go to the Labels page:
* Github : https://github.com/{owner}/{repo}/labels, or click on the "Labels" tab in the issues or PRs page.