code_review: PR #596

love-linger · love-linger · commit 12bb915bd899 · 2024-10-24T10:22:06.000+08:00
- Add `ViewModels.Preference.PrepareOpenAIPrompt()` method to generate default prompt instead of a const fallback value. Therefore, it is more convenient for us to modify the default value in the Preference dialog.
- Modify the default prompts. Rename `SubjectPrompt` to `GenerateSubjectPrompt`. Rename `SummaryPrompt` to `AnalyzeDiffPrompt`.
- Rewrite the way to build OpenAI user content for subject generation

Signed-off-by: leo &lt;longshuang@msn.cn&gt;
diff --git a/src/Commands/GenerateCommitMessage.cs b/src/Commands/GenerateCommitMessage.cs
@@ -10,33 +10,6 @@ namespace SourceGit.Commands
     /// </summary>
     public class GenerateCommitMessage
     {
-        private const string DEFAULT_SUMMARY_PROMPT = """
-            You are an expert developer specialist in creating commits.
-            Provide a super concise one sentence overall changes summary of the user `git diff` output following strictly the next rules:
-            - Do not use any code snippets, imports, file routes or bullets points.
-            - Do not mention the route of file that has been change.
-            - Simply describe the MAIN GOAL of the changes.
-            - Output directly the summary in plain text.
-            """;
-
-        private const string DEFAULT_SUBJECT_PROMPT = """
-            You are an expert developer specialist in creating commits messages.
-            Your only goal is to retrieve a single commit message.
-            Based on the provided user changes, combine them in ONE SINGLE commit message retrieving the global idea, following strictly the next rules:
-            - Assign the commit {type} according to the next conditions:
-              feat: Only when adding a new feature.
-              fix: When fixing a bug.
-              docs: When updating documentation.
-              style: When changing elements styles or design and/or making changes to the code style (formatting, missing semicolons, etc.) without changing the code logic.
-              test: When adding or updating tests.
-              chore: When making changes to the build process or auxiliary tools and libraries.
-              revert: When undoing a previous commit.
-              refactor: When restructuring code without changing its external behavior, or is any of the other refactor types.
-            - Do not add any issues numeration, explain your output nor introduce your answer.
-            - Output directly only one commit message in plain text with the next format: {type}: {commit_message}.
-            - Be as concise as possible, keep the message under 50 characters.
-            """;
-
         public class GetDiffContent : Command
         {
             public GetDiffContent(string repo, Models.DiffOption opt)
@@ -59,31 +32,36 @@ public string Result()
         {
             try
             {
-                var summaries = new List<string>();
+                var summarybuilder = new StringBuilder();
+                var bodyBuilder = new StringBuilder();
                 foreach (var change in _changes)
                 {
                     if (_cancelToken.IsCancellationRequested)
                         return "";
 
                     _onProgress?.Invoke($"Analyzing {change.Path}...");
+
                     var summary = GenerateChangeSummary(change);
-                    summaries.Add(summary);
+                    summarybuilder.Append("- ");
+                    summarybuilder.Append(summary);
+                    summarybuilder.Append("(file: ");
+                    summarybuilder.Append(change.Path);
+                    summarybuilder.Append(")");
+                    summarybuilder.AppendLine();
+
+                    bodyBuilder.Append("- ");
+                    bodyBuilder.Append(summary);
+                    bodyBuilder.AppendLine();
                 }
 
                 if (_cancelToken.IsCancellationRequested)
                     return "";
 
                 _onProgress?.Invoke($"Generating commit message...");
-                var builder = new StringBuilder();
-                builder.Append(GenerateSubject(string.Join("", summaries)));
-                builder.Append("\n");
-                foreach (var summary in summaries)
-                {
-                    builder.Append("\n- ");
-                    builder.Append(summary.Trim());
-                }
 
-                return builder.ToString();
+                var body = bodyBuilder.ToString();
+                var subject = GenerateSubject(summarybuilder.ToString());
+                return string.Format("{0}\n\n{1}", subject, body);
             }
             catch (Exception e)
             {
@@ -97,12 +75,7 @@ private string GenerateChangeSummary(Models.Change change)
             var rs = new GetDiffContent(_repo, new Models.DiffOption(change, false)).ReadToEnd();
             var diff = rs.IsSuccess ? rs.StdOut : "unknown change";
 
-            var prompt = string.IsNullOrWhiteSpace(Models.OpenAI.SummaryPrompt)
-                ? DEFAULT_SUMMARY_PROMPT
-                : Models.OpenAI.SummaryPrompt;
-
-            var rsp = Models.OpenAI.Chat(prompt, $"Here is the `git diff` output: {diff}", _cancelToken);
-
+            var rsp = Models.OpenAI.Chat(Models.OpenAI.AnalyzeDiffPrompt, $"Here is the `git diff` output: {diff}", _cancelToken);
             if (rsp != null && rsp.Choices.Count > 0)
                 return rsp.Choices[0].Message.Content;
 
@@ -111,12 +84,7 @@ private string GenerateChangeSummary(Models.Change change)
 
         private string GenerateSubject(string summary)
         {
-            var prompt = string.IsNullOrWhiteSpace(Models.OpenAI.SubjectPrompt)
-                ? DEFAULT_SUBJECT_PROMPT
-                : Models.OpenAI.SubjectPrompt;
-
-            var rsp = Models.OpenAI.Chat(prompt, $"Here are the summaries changes: {summary}", _cancelToken);
-
+            var rsp = Models.OpenAI.Chat(Models.OpenAI.GenerateSubjectPrompt, $"Here are the summaries changes:\n{summary}", _cancelToken);
             if (rsp != null && rsp.Choices.Count > 0)
                 return rsp.Choices[0].Message.Content;
 
diff --git a/src/Models/OpenAI.cs b/src/Models/OpenAI.cs
@@ -94,13 +94,13 @@ public static string Model
             set;
         }
 
-        public static string SubjectPrompt
+        public static string AnalyzeDiffPrompt
         {
             get;
             set;
         }
 
-        public static string SummaryPrompt
+        public static string GenerateSubjectPrompt
         {
             get;
             set;
diff --git a/src/Resources/Locales/en_US.axaml b/src/Resources/Locales/en_US.axaml
@@ -400,34 +400,11 @@
   <x:String x:Key="Text.Period.YearsAgo" xml:space="preserve">{0} years ago</x:String>
   <x:String x:Key="Text.Preference" xml:space="preserve">Preference</x:String>
   <x:String x:Key="Text.Preference.AI" xml:space="preserve">OPEN AI</x:String>
-  <x:String x:Key="Text.Preference.AI.Server" xml:space="preserve">Server</x:String>
+  <x:String x:Key="Text.Preference.AI.AnalyzeDiffPrompt" xml:space="preserve">Analyze Diff Prompt</x:String>
   <x:String x:Key="Text.Preference.AI.ApiKey" xml:space="preserve">API Key</x:String>
+  <x:String x:Key="Text.Preference.AI.GenerateSubjectPrompt" xml:space="preserve">Generate Subject Prompt</x:String>
   <x:String x:Key="Text.Preference.AI.Model" xml:space="preserve">Model</x:String>
-  <x:String x:Key="Text.Preference.AI.SummaryPrompt" xml:space="preserve">Summary Prompt</x:String>
-  <x:String x:Key="Text.Preference.AI.SubjectPrompt" xml:space="preserve">Subject Prompt</x:String>
-  <x:String x:Key="Text.Preference.AI.SummaryPromptHint" xml:space="preserve">You are an expert developer specialist in creating commits.
-Provide a super concise one sentence overall changes summary of the user `git diff` output following strictly the next rules:
-- Do not use any code snippets, imports, file routes or bullets points.
-- Do not mention the route of file that has been change.
-- Simply describe the MAIN GOAL of the changes.
-- Output directly the summary in plain text.
-</x:String>
-  <x:String x:Key="Text.Preference.AI.SubjectPromptHint" xml:space="preserve">You are an expert developer specialist in creating commits messages.
-Your only goal is to retrieve a single commit message.
-Based on the provided user changes, combine them in ONE SINGLE commit message retrieving the global idea, following strictly the next rules:
-- Assign the commit {type} according to the next conditions:
-  feat: Only when adding a new feature.
-  fix: When fixing a bug.
-  docs: When updating documentation.
-  style: When changing elements styles or design and/or making changes to the code style (formatting, missing semicolons, etc.) without changing the code logic.
-  test: When adding or updating tests.
-  chore: When making changes to the build process or auxiliary tools and libraries.
-  revert: When undoing a previous commit.
-  refactor: When restructuring code without changing its external behavior, or is any of the other refactor types.
-- Do not add any issues numeration, explain your output nor introduce your answer.
-- Output directly only one commit message in plain text with the next format: {type}: {commit_message}.
-- Be as concise as possible, keep the message under 50 characters.
-</x:String>
+  <x:String x:Key="Text.Preference.AI.Server" xml:space="preserve">Server</x:String>
   <x:String x:Key="Text.Preference.Appearance" xml:space="preserve">APPEARANCE</x:String>
   <x:String x:Key="Text.Preference.Appearance.DefaultFont" xml:space="preserve">Default Font</x:String>
   <x:String x:Key="Text.Preference.Appearance.DefaultFontSize" xml:space="preserve">Default Font Size</x:String>
diff --git a/src/ViewModels/Preference.cs b/src/ViewModels/Preference.cs
@@ -25,6 +25,7 @@ public static Preference Instance
                 _instance.PrepareGit();
                 _instance.PrepareShellOrTerminal();
                 _instance.PrepareWorkspaces();
+                _instance.PrepareOpenAIPrompt();
 
                 return _instance;
             }
@@ -315,27 +316,27 @@ public string OpenAIModel
             }
         }
 
-        public string OpenAISubjectPrompt
+        public string OpenAIAnalyzeDiffPrompt
         {
-            get => Models.OpenAI.SubjectPrompt;
+            get => Models.OpenAI.AnalyzeDiffPrompt;
             set
             {
-                if (value != Models.OpenAI.SubjectPrompt)
+                if (value != Models.OpenAI.AnalyzeDiffPrompt)
                 {
-                    Models.OpenAI.SubjectPrompt = value;
+                    Models.OpenAI.AnalyzeDiffPrompt = value;
                     OnPropertyChanged();
                 }
             }
         }
 
-        public string OpenAISummaryPrompt
+        public string OpenAIGenerateSubjectPrompt
         {
-            get => Models.OpenAI.SummaryPrompt;
+            get => Models.OpenAI.GenerateSubjectPrompt;
             set
             {
-                if (value != Models.OpenAI.SummaryPrompt)
+                if (value != Models.OpenAI.GenerateSubjectPrompt)
                 {
-                    Models.OpenAI.SummaryPrompt = value;
+                    Models.OpenAI.GenerateSubjectPrompt = value;
                     OnPropertyChanged();
                 }
             }
@@ -553,6 +554,45 @@ private void PrepareWorkspaces()
             }
         }
 
+        private void PrepareOpenAIPrompt()
+        {
+            if (string.IsNullOrEmpty(Models.OpenAI.AnalyzeDiffPrompt))
+            {
+                Models.OpenAI.AnalyzeDiffPrompt = """
+                    You are an expert developer specialist in creating commits.
+                    Provide a super concise one sentence overall changes summary of the user `git diff` output following strictly the next rules:
+                    - Do not use any code snippets, imports, file routes or bullets points.
+                    - Do not mention the route of file that has been change.
+                    - Write clear, concise, and descriptive messages that explain the MAIN GOAL made of the changes.
+                    - Use the present tense and active voice in the message, for example, "Fix bug" instead of "Fixed bug.".
+                    - Use the imperative mood, which gives the message a sense of command, e.g. "Add feature" instead of "Added feature".
+                    - Avoid using general terms like "update" or "change", be specific about what was updated or changed.
+                    - Avoid using terms like "The main goal of", just output directly the summary in plain text
+                    """;
+            }
+
+            if (string.IsNullOrEmpty(Models.OpenAI.GenerateSubjectPrompt))
+            {
+                Models.OpenAI.GenerateSubjectPrompt = """
+                    You are an expert developer specialist in creating commits messages.
+                    Your only goal is to retrieve a single commit message.
+                    Based on the provided user changes, combine them in ONE SINGLE commit message retrieving the global idea, following strictly the next rules:
+                    - Assign the commit {type} according to the next conditions:
+                        feat: Only when adding a new feature.
+                        fix: When fixing a bug.
+                        docs: When updating documentation.
+                        style: When changing elements styles or design and/or making changes to the code style (formatting, missing semicolons, etc.) without changing the code logic.
+                        test: When adding or updating tests.
+                        chore: When making changes to the build process or auxiliary tools and libraries.
+                        revert: When undoing a previous commit.
+                        refactor: When restructuring code without changing its external behavior, or is any of the other refactor types.
+                    - Do not add any issues numeration, explain your output nor introduce your answer.
+                    - Output directly only one commit message in plain text with the next format: {type}: {commit_message}.
+                    - Be as concise as possible, keep the message under 50 characters.
+                    """;
+            }
+        }
+
         private RepositoryNode FindNodeRecursive(string id, List<RepositoryNode> collection)
         {
             foreach (var node in collection)
diff --git a/src/Views/Preference.axaml b/src/Views/Preference.axaml
@@ -499,31 +499,27 @@
                        Text="{Binding OpenAIApiKey, Mode=TwoWay}"/>
 
               <TextBlock Grid.Row="3" Grid.Column="0"
-                         Text="{DynamicResource Text.Preference.AI.SubjectPrompt}"
+                         Text="{DynamicResource Text.Preference.AI.AnalyzeDiffPrompt}"
                          HorizontalAlignment="Right"
                          Margin="0,0,16,0"/>
-
               <TextBox Grid.Row="3" Grid.Column="1"
                        Height="120"
                        CornerRadius="3"
                        VerticalContentAlignment="Top"
-                       Text="{Binding OpenAISubjectPrompt, Mode=TwoWay}"
+                       Text="{Binding OpenAIAnalyzeDiffPrompt, Mode=TwoWay}"
                        AcceptsReturn="true"
-                       Watermark="{DynamicResource Text.Preference.AI.SubjectPromptHint}"
                        TextWrapping="Wrap"/>
 
               <TextBlock Grid.Row="4" Grid.Column="0"
-                         Text="{DynamicResource Text.Preference.AI.SummaryPrompt}"
+                         Text="{DynamicResource Text.Preference.AI.GenerateSubjectPrompt}"
                          HorizontalAlignment="Right"
                          Margin="0,0,16,0"/>
-
               <TextBox Grid.Row="4" Grid.Column="1"
                        Height="120"
                        CornerRadius="3"
                        VerticalContentAlignment="Top"
-                       Text="{Binding OpenAISummaryPrompt, Mode=TwoWay}"
+                       Text="{Binding OpenAIGenerateSubjectPrompt, Mode=TwoWay}"
                        AcceptsReturn="true"
-                       Watermark="{DynamicResource Text.Preference.AI.SummaryPromptHint}"
                        TextWrapping="Wrap"/>
             </Grid>
           </StackPanel>

Original file line number	Diff line number	Diff line change
`@@ -94,13 +94,13 @@ public static string Model`
`94`	`94`	`set;`
`95`	`95`	`}`
`96`	`96`
`97`		`- public static string SubjectPrompt`
	`97`	`+ public static string AnalyzeDiffPrompt`
`98`	`98`	`{`
`99`	`99`	`get;`
`100`	`100`	`set;`
`101`	`101`	`}`
`102`	`102`
`103`		`- public static string SummaryPrompt`
	`103`	`+ public static string GenerateSubjectPrompt`
`104`	`104`	`{`
`105`	`105`	`get;`
`106`	`106`	`set;`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ public static Preference Instance`
`25`	`25`	`_instance.PrepareGit();`
`26`	`26`	`_instance.PrepareShellOrTerminal();`
`27`	`27`	`_instance.PrepareWorkspaces();`
	`28`	`+ _instance.PrepareOpenAIPrompt();`
`28`	`29`
`29`	`30`	`return _instance;`
`30`	`31`	`}`
`@@ -315,27 +316,27 @@ public string OpenAIModel`
`315`	`316`	`}`
`316`	`317`	`}`
`317`	`318`
`318`		`- public string OpenAISubjectPrompt`
	`319`	`+ public string OpenAIAnalyzeDiffPrompt`
`319`	`320`	`{`
`320`		`- get => Models.OpenAI.SubjectPrompt;`
	`321`	`+ get => Models.OpenAI.AnalyzeDiffPrompt;`
`321`	`322`	`set`
`322`	`323`	`{`
`323`		`- if (value != Models.OpenAI.SubjectPrompt)`
	`324`	`+ if (value != Models.OpenAI.AnalyzeDiffPrompt)`
`324`	`325`	`{`
`325`		`- Models.OpenAI.SubjectPrompt = value;`
	`326`	`+ Models.OpenAI.AnalyzeDiffPrompt = value;`
`326`	`327`	`OnPropertyChanged();`
`327`	`328`	`}`
`328`	`329`	`}`
`329`	`330`	`}`
`330`	`331`
`331`		`- public string OpenAISummaryPrompt`
	`332`	`+ public string OpenAIGenerateSubjectPrompt`
`332`	`333`	`{`
`333`		`- get => Models.OpenAI.SummaryPrompt;`
	`334`	`+ get => Models.OpenAI.GenerateSubjectPrompt;`
`334`	`335`	`set`
`335`	`336`	`{`
`336`		`- if (value != Models.OpenAI.SummaryPrompt)`
	`337`	`+ if (value != Models.OpenAI.GenerateSubjectPrompt)`
`337`	`338`	`{`
`338`		`- Models.OpenAI.SummaryPrompt = value;`
	`339`	`+ Models.OpenAI.GenerateSubjectPrompt = value;`
`339`	`340`	`OnPropertyChanged();`
`340`	`341`	`}`
`341`	`342`	`}`
`@@ -553,6 +554,45 @@ private void PrepareWorkspaces()`
`553`	`554`	`}`
`554`	`555`	`}`
`555`	`556`
	`557`	`+ private void PrepareOpenAIPrompt()`
	`558`	`+ {`
	`559`	`+ if (string.IsNullOrEmpty(Models.OpenAI.AnalyzeDiffPrompt))`
	`560`	`+ {`
	`561`	`+ Models.OpenAI.AnalyzeDiffPrompt = """`
	`562`	`+ You are an expert developer specialist in creating commits.`
	`563`	+ Provide a super concise one sentence overall changes summary of the user `git diff` output following strictly the next rules:
	`564`	`+ - Do not use any code snippets, imports, file routes or bullets points.`
	`565`	`+ - Do not mention the route of file that has been change.`
	`566`	`+ - Write clear, concise, and descriptive messages that explain the MAIN GOAL made of the changes.`
	`567`	`+ - Use the present tense and active voice in the message, for example, "Fix bug" instead of "Fixed bug.".`
	`568`	`+ - Use the imperative mood, which gives the message a sense of command, e.g. "Add feature" instead of "Added feature".`
	`569`	`+ - Avoid using general terms like "update" or "change", be specific about what was updated or changed.`
	`570`	`+ - Avoid using terms like "The main goal of", just output directly the summary in plain text`
	`571`	`+ """;`
	`572`	`+ }`
	`573`	`+`
	`574`	`+ if (string.IsNullOrEmpty(Models.OpenAI.GenerateSubjectPrompt))`
	`575`	`+ {`
	`576`	`+ Models.OpenAI.GenerateSubjectPrompt = """`
	`577`	`+ You are an expert developer specialist in creating commits messages.`
	`578`	`+ Your only goal is to retrieve a single commit message.`
	`579`	`+ Based on the provided user changes, combine them in ONE SINGLE commit message retrieving the global idea, following strictly the next rules:`
	`580`	`+ - Assign the commit {type} according to the next conditions:`
	`581`	`+ feat: Only when adding a new feature.`
	`582`	`+ fix: When fixing a bug.`
	`583`	`+ docs: When updating documentation.`
	`584`	`+ style: When changing elements styles or design and/or making changes to the code style (formatting, missing semicolons, etc.) without changing the code logic.`
	`585`	`+ test: When adding or updating tests.`
	`586`	`+ chore: When making changes to the build process or auxiliary tools and libraries.`
	`587`	`+ revert: When undoing a previous commit.`
	`588`	`+ refactor: When restructuring code without changing its external behavior, or is any of the other refactor types.`
	`589`	`+ - Do not add any issues numeration, explain your output nor introduce your answer.`
	`590`	`+ - Output directly only one commit message in plain text with the next format: {type}: {commit_message}.`
	`591`	`+ - Be as concise as possible, keep the message under 50 characters.`
	`592`	`+ """;`
	`593`	`+ }`
	`594`	`+ }`
	`595`	`+`
`556`	`596`	`private RepositoryNode FindNodeRecursive(string id, List<RepositoryNode> collection)`
`557`	`597`	`{`
`558`	`598`	`foreach (var node in collection)`