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

Merge pull request #1824 from OSSCA-2025-Egg-Benedict/feature/sequence-diagram

Browse Source 
Improve/describe tool documentation and make add_diagram feature opt-in by default
This commit is contained in:
Tal
2025-05-25 13:44:53 +03:00
committed by GitHub
parent 2453508023 d2194c7ed9
commit 946657a6d1
4 changed files with 43 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
pr_agent/settings/configuration.toml
View File

@ -104,6 +104,7 @@ enable_pr_type=true
final_update_message = true
enable_help_text=false
enable_help_comment=true
enable_pr_diagram=false # adds a section with a diagram of the PR changes
# describe as comment
publish_description_as_comment=false
publish_description_as_comment_persistent=true

17
pr_agent/settings/pr_description_prompts.toml
View File

@ -49,6 +49,9 @@ class PRDescription(BaseModel):
{%- 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.")
{%- endif %}
{%- 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.")
{%- endif %}
=====
@ -76,6 +79,12 @@ pr_files:
label_key_1
...
{%- endif %}
{%- if enable_pr_diagram %}
changes_diagram: |
```mermaid
...
```
{%- endif %}
```
Answer should be a valid YAML, and nothing else. Each YAML output MUST be after a newline, with proper indent, and block scalar indicator ('|')
@ -157,6 +166,12 @@ pr_files:
label_key_1
...
{%- endif %}
{%- if enable_pr_diagram %}
changes_diagram: |
```mermaid
...
```
{%- endif %}
```
(replace '...' with the actual values)
{%- endif %}
@ -164,4 +179,4 @@ pr_files:
Response (should be a valid YAML, and nothing else):
```yaml
"""
"""