improve the prompt a bit

Author: harjotgill

action.yml

@@ -38,8 +38,8 @@ inputs:
     description: 'System message to be sent to ChatGPT'
     default: |
       You are a very experienced software engineer. You are able to thoroughly review code and uncover 
-      issues, such as potential data races, livelocks, starvation, suspension, order violation, 
-      atomicity violation, consistency issues, complexity issues and so on. 
+      issues, such as bugs, potential data races, livelocks, starvation, suspension, order violation, 
+      atomicity violation, consistency issues, complexity issues, error handling and so on. 
 
       We will be doing code reviews today. Please prefer markdown format in your responses.
   chatgpt_reverse_proxy:
@@ -70,7 +70,7 @@ inputs:
     required: false
     description: 'The prompt for each file'
     default: |
-      Providing `$filename` content as context. Reply "OK" to confirm.
+      Providing `$filename` content as context. Please use this context when reviewing patches.
 
       ```
       $file_content
@@ -79,7 +79,7 @@ inputs:
     required: false
     description: 'The prompt for each file diff'
     default: |
-      Providing entire diff for `$filename` as context. Reply "OK" to confirm.
+      Providing entire diff for `$filename` as context. Please use this context when revieweing patches.
 
       ```diff
       $file_diff
@@ -119,8 +119,9 @@ inputs:
       > $description.
 
       Next, I will be providing you diffs for each file for you to summarize. In every response, 
-      you will update the high-level summary of the entire pull request, and the table for each file's 
-      diff summary.
+      you will update the high-level summary of the entire pull request, the table for each file's 
+      diff summary and any feedback you might want to give to the developer, including compliments 
+      or suggestions on how to do better next time.
 
       Reply "OK" to confirm that you are ready to receive the diffs for summarization.
   summarize_file_diff:
@@ -131,8 +132,8 @@ inputs:
 
       I would like you to summarize the diff and add the summary for this file in the table. 
 
-      In response, please provide the updated high-level summary and the summary table of the files 
-      we have summarized so far.
+      In response, please provide the updated high-level summary, the summary table of the files 
+      we have summarized so far and your overall feedback to the developer.
 
       ```diff
       $file_diff
@@ -143,10 +144,12 @@ inputs:
     default: |
       This is the end of summarization session. Please provide the final response as follows in 
       the `markdown` format with the following content:
+        - Thank the user for letting you participate in the code review.
         - High-level summary (focus on the purpose and intent within 50 words)
+        - Your feedback to the developer (within 50 words)
         - Table of files and their summaries
 
-      Do not provide additional commentary as this summary will be added as a comment on the PR.
+      Do not provide any additional commentary as this summary will be added as a comment on the PR.
   summarize_release_notes:
     required: false
     description: 'The prompt for generating release notes'

dist/index.js

@@ -12,6 +12,10 @@ const token = core.getInput('token')
 const octokit = new Octokit({auth: `token ${token}`})
 const context = github.context
 const repo = context.repo
+const description_tag =
+  '<!-- This is an auto-generated comment: release notes by chatgpt -->'
+const description_tag_end =
+  '<!-- end of auto-generated comment: release notes by chatgpt -->'
 
 const MAX_TOKENS_FOR_EXTRA_CONTENT = 2500
 
@@ -39,6 +43,14 @@ export const codeReview = async (
   inputs.title = context.payload.pull_request.title
   if (context.payload.pull_request.body) {
     inputs.description = context.payload.pull_request.body
+    // remove our summary from description by looking for description_tag and description_tag_end
+    const start = inputs.description.indexOf(description_tag)
+    const end = inputs.description.indexOf(description_tag_end)
+    if (start >= 0 && end >= 0) {
+      inputs.description =
+        inputs.description.slice(0, start) +
+        inputs.description.slice(end + description_tag_end.length)
+    }
   }
   // as gpt-3.5-turbo isn't paying attention to system message, add to inputs for now
   inputs.system_message = options.system_message
@@ -243,24 +255,20 @@ export const codeReview = async (
       next_summarize_ids = release_notes_ids
       // add this response to the description field of the PR as release notes by looking
       // for the tag (marker)
-      const tag =
-        '<!-- This is an auto-generated comment: release notes by chatgpt -->'
-      const tag_end =
-        '<!-- end of auto-generated comment: release notes by chatgpt -->'
       try {
         const description = inputs.description
 
         // find the tag in the description and replace the content between the tag and the tag_end
         // if not found, add the tag and the content to the end of the description
-        const tag_index = description.indexOf(tag)
-        const tag_end_index = description.indexOf(tag_end)
+        const tag_index = description.indexOf(description_tag)
+        const tag_end_index = description.indexOf(description_tag_end)
         if (tag_index === -1 || tag_end_index === -1) {
           let new_description = description
-          new_description += tag
+          new_description += description_tag
           new_description += '\n### Summary by ChatGPT\n'
           new_description += release_notes_response
           new_description += '\n'
-          new_description += tag_end
+          new_description += description_tag_end
           await octokit.pulls.update({
             owner: repo.owner,
             repo: repo.repo,
@@ -269,13 +277,13 @@ export const codeReview = async (
           })
         } else {
           let new_description = description.substring(0, tag_index)
-          new_description += tag
+          new_description += description_tag
           new_description += '\n### Summary by ChatGPT\n'
           new_description += release_notes_response
           new_description += '\n'
-          new_description += tag_end
+          new_description += description_tag_end
           new_description += description.substring(
-            tag_end_index + tag_end.length
+            tag_end_index + description_tag_end.length
           )
           await octokit.pulls.update({
             owner: repo.owner,