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

fix: improve Mermaid diagram formatting and instructions in PR description template

Browse Source
This commit is contained in:
mrT23
2025-05-25 14:59:18 +03:00
parent f3cb4e8384
commit 2eeb9b0411
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
pr_agent/settings/pr_description_prompts.toml
View File

@ -47,7 +47,7 @@ class PRDescription(BaseModel):
description: str = Field(description="summarize the PR changes in up to four bullet points, each up to 8 words. For large PRs, add sub-bullets if needed. Order bullets by importance, with each bullet highlighting a key change group.") description: str = Field(description="summarize the PR changes in up to four bullet points, each up to 8 words. For large PRs, add sub-bullets if needed. Order bullets by importance, with each bullet highlighting a key change group.")
title: str = Field(description="a concise and descriptive title that captures the PR's main theme") title: str = Field(description="a concise and descriptive title that captures the PR's main theme")
{%- if enable_pr_diagram %} {%- if enable_pr_diagram %}
changes_diagram: str = Field(description="a horizontal diagram that represents the main PR changes, in the format of a mermaid flowchart. The diagram should be concise and easy to read. Leave empty if no diagram is relevant.") changes_diagram: str = Field(description="a horizontal diagram that represents the main PR changes, in the format of a valid mermaid LR flowchart. The diagram should be concise and easy to read. Leave empty if no diagram is relevant. To create robust Mermaid diagrams, follow this two-step process: (1) Declare first the nodes: nodeID['Node Label']. (2) Then define the links: nodeID1 -- 'link text' --> nodeID2 ")
{%- endif %} {%- endif %}
{%- if enable_semantic_files_types %} {%- if enable_semantic_files_types %}
pr_files: List[FileDescription] = Field(max_items=20, description="a list of all the files that were changed in the PR, and summary of their changes. Each file must be analyzed regardless of change size.") pr_files: List[FileDescription] = Field(max_items=20, description="a list of all the files that were changed in the PR, and summary of their changes. Each file must be analyzed regardless of change size.")
@ -68,6 +68,7 @@ title: |
{%- if enable_pr_diagram %} {%- if enable_pr_diagram %}
changes_diagram: | changes_diagram: |
```mermaid ```mermaid
flowchart LR
... ...
``` ```
{%- endif %} {%- endif %}
@ -155,6 +156,7 @@ title: |
{%- if enable_pr_diagram %} {%- if enable_pr_diagram %}
changes_diagram: | changes_diagram: |
```mermaid ```mermaid
flowchart LR
... ...
``` ```
{%- endif %} {%- endif %}