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

This commit is contained in:
mrT23
2025-05-25 14:59:18 +03:00
parent f3cb4e8384
commit 2eeb9b0411

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.")
title: str = Field(description="a concise and descriptive title that captures the PR's main theme")
{%- 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 %}
{%- 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.")
@ -68,7 +68,8 @@ title: |
{%- if enable_pr_diagram %}
changes_diagram: |
```mermaid
...
flowchart LR
...
```
{%- endif %}
{%- if enable_semantic_files_types %}
@ -155,7 +156,8 @@ title: |
{%- if enable_pr_diagram %}
changes_diagram: |
```mermaid
...
flowchart LR
...
```
{%- endif %}
{%- if enable_semantic_files_types %}