xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-03 04:10:49 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
1b22e59b4b9501da77ea7844cbb1a796201a9bb9
pr-agent/docs/DESCRIBE.md
mrT23 f908d02ab4 readme
2023-12-07 15:26:36 +02:00

3.3 KiB
Raw Blame History

Describe Tool

The describe tool scans the PR code changes, and automatically generates PR description - title, type, summary, walkthrough and labels. It can be invoked manually by commenting on any PR:

/describe

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 and GitHub Action

Configuration options

Under the section 'pr_description', the configuration file contains options to customize the 'describe' tool:

  • publish_labels: if set to true, the tool will publish the labels to the PR. Default is true.

  • publish_description_as_comment: if set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the origianl description. Default is false.

  • add_original_user_description: if set to true, the tool will add the original user description to the generated description. Default is false.

  • keep_original_user_title: if set to true, the tool will keep the original PR title, and won't change it. Default is false.

  • extra_instructions: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".

  • To enable custom labels, apply the configuration changes described here

  • enable_pr_type: if set to false, it will not show the PR type as a text value in the description content. Default is true.

  • final_update_message: if set to true, it will add a comment message PR Description updated to latest commit... after finishing calling /describe. Default is true.

  • enable_semantic_files_types: if set to true, "PR changes walkthrough" section will be generated. Default is true.

Markers template

markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism.

For example, if the PR original description was:

User content...


## PR Description:
pr_agent:summary

## PR Walkthrough:
pr_agent:walkthrough

The marker pr_agent:summary will be replaced with the PR summary, and pr_agent:walkthrough will be replaced with the PR walkthrough.

Example:
        env:
          pr_description.use_description_markers: 'true'

==>

Configuration params:
  • use_description_markers: if set to true, the tool will use markers template. It replaces every marker of the form pr_agent:marker_name with the relevant content. Default is false.
  • include_generated_by_header: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true.