From 4dcbce41c86563177eb5fc50ed9aaf2ee5ad283a Mon Sep 17 00:00:00 2001
From: mrT23 <tal.r@codium.ai>
Date: Sun, 3 Dec 2023 17:27:22 +0200
Subject: [PATCH] feat: Refine prompts and improve formatting in
 pr_sort_code_suggestions_prompts.toml and pr_update_changelog_prompts.toml

---
 .../pr_sort_code_suggestions_prompts.toml     |  6 ++--
 .../settings/pr_update_changelog_prompts.toml | 36 +++++++++++--------
 2 files changed, 25 insertions(+), 17 deletions(-)

diff --git a/pr_agent/settings/pr_sort_code_suggestions_prompts.toml b/pr_agent/settings/pr_sort_code_suggestions_prompts.toml
index f4a3f5bf..33599ba3 100644
--- a/pr_agent/settings/pr_sort_code_suggestions_prompts.toml
+++ b/pr_agent/settings/pr_sort_code_suggestions_prompts.toml
@@ -2,10 +2,10 @@
 system="""
 """
 
-user="""You are given a list of code suggestions to improve a git Pull Request (PR):
-'
+user="""You are given a list of code suggestions to improve a Git Pull Request (PR):
+======
 {{ suggestion_str|trim }}
-'
+======
 
 Your task is to sort the code suggestions by their order of importance, and return a list with sorting order.
 The sorting order is a list of pairs, where each pair contains the index of the suggestion in the original list.
diff --git a/pr_agent/settings/pr_update_changelog_prompts.toml b/pr_agent/settings/pr_update_changelog_prompts.toml
index 9d00f251..121f43a0 100644
--- a/pr_agent/settings/pr_update_changelog_prompts.toml
+++ b/pr_agent/settings/pr_update_changelog_prompts.toml
@@ -1,5 +1,5 @@
 [pr_update_changelog_prompt]
-system="""You are a language model called CodiumAI-PR-Changlog-summarizer.
+system="""You are a language model called PR-Changelog-Updater.
 Your task is to update the CHANGELOG.md file of the project, to shortly summarize important changes introduced in this PR (the '+' lines).
 - The output should match the existing CHANGELOG.md format, style and conventions, so it will look like a natural part of the file. For example, if previous changes were summarized in a single line, you should do the same.
 - Don't repeat previous changes. Generate only new content, that is not already in the CHANGELOG.md file.
@@ -8,9 +8,9 @@ Your task is to update the CHANGELOG.md file of the project, to shortly summariz
 {%- if extra_instructions %}
 
 Extra instructions from the user:
-'
-{{ extra_instructions }}
-'
+======
+{{ extra_instructions|trim }}
+======
 {%- endif %}
 """
 
@@ -20,7 +20,13 @@ Title: '{{title}}'
 
 Branch: '{{branch}}'
 
-Description: '{{description}}'
+{%- if description %}
+
+Description:
+======
+{{ description|trim }}
+======
+{%- endif %}
 
 {%- if language %}
 
@@ -28,17 +34,18 @@ Main PR language: '{{ language }}'
 {%- endif %}
 {%- if commit_messages_str %}
 
+
 Commit messages:
-'
-{{ commit_messages_str }}
-'
+======
+{{ commit_messages_str|trim }}
+======
 {%- endif %}
 
 
-The PR Diff:
-```
-{{diff}}
-```
+The PR Git Diff:
+======
+{{ diff|trim }}
+======
 
 Current date:
 ```
@@ -46,9 +53,10 @@ Current date:
 ```
 
 The current CHANGELOG.md:
-```
+======
 {{ changelog_file_str }}
-```
+======
+
 
 Response:
 """