Optimize prompts to use fewer tokens (#110)

Co-authored-by: Harjot Gill <[email protected]>

Author: karansohi

action.yml

@@ -53,9 +53,13 @@ inputs:
       !**/_gen/**
       !**/generated/**
       !**/vendor/**
-  openai_model:
+  openai_summary_model:
     required: false
-    description: 'Model to use'
+    description: 'Model to use for summarization'
+    default: 'gpt-3.5-turbo'
+  openai_review_model:
+    required: false
+    description: 'Model to use for review'
     default: 'gpt-3.5-turbo'
   openai_model_temperature:
     required: false
@@ -78,37 +82,26 @@ inputs:
     required: false
     description: 'System message to be sent to OpenAI'
     default: |
-      You are `@openai` (aka `github-actions[bot]`), a highly
-      experienced software engineer with a strong ability to review 
-      code changes thoroughly.
-
-      Your role today is to conduct code and documentation reviews, and 
-      generate code and documentation if asked to do so. You will point 
-      out potential issues such as security (e.g. XSS), logic errors, 
-      syntax errors, out of bound errors, data races, livelocks, starvation, 
-      suspension, order violation, atomicity violation, consistency, 
-      complexity, error handling, typos, grammar, and more.
-  summarize_beginning:
+      You are `@openai` (aka `github-actions[bot]`), a language model 
+      trained by OpenAI. You have been designed to act as a highly 
+      experienced software engineer today. Your main task is to review 
+      code and documentation, provide suggestions, and write new code 
+      or documentation when requested. Please ensure that your responses
+      are focused on assisting with code and documentation concerns, 
+      following best practices and industry standards.
+  summarize_file_diff:
     required: false
     description: 'The prompt for the whole pull request'
     default: |
-      $system_message
-
-      In this session, we will summarize a pull request. 
+      In this session, we will summarize a pull request and a diff alltogether. 
 
       The pull request has the title "$title" and the following description:
 
       ```
       $description
       ```
-
-      Reply "OK" to confirm that you are ready.
-  summarize_file_diff:
-    required: false
-    description: 'The prompt for each file diff'
-    default: |
       I am providing diff for `$filename` below. I would like you to summarize 
-      the diff within 30 words.
+      the diff within 50 words.
 
       ```diff
       $file_diff
@@ -148,16 +141,10 @@ inputs:
       Below the release notes, generate a short, celebratory poem about the 
       changes in this PR and add this poem as a quote (> symbol). You can 
       use emojis in the poem, where they are relevant.
-  review_beginning:
+  review_file_diff:
     required: false
-    description: 'The beginning prompt of a code review dialog'
+    description: 'The prompt for each file'
     default: |
-      $system_message
-
-      I will provide you with some files and the entire diff to help you build 
-      context, unless the content is too large. Then, I will send you each patch 
-      from the diff for review.
-
       The pull request has the title "$title" and the following description:
 
       ```
@@ -170,68 +157,55 @@ inputs:
       $summary
       ```
 
-      Reply "OK" to confirm.
-  review_file:
-    required: false
-    description: 'The prompt for each file'
-    default: |
-      Here is the content of `$filename` for context. Please use this context 
-      when reviewing patches.
+      Content of `$filename` is follows.
 
       ```
       $file_content
       ```
 
-      Reply "LGTM!" if the existing code in this file looks correct. If there 
-      are serious issues in the existing code please let me know and I will 
-      add your comment on the pull request for this file.
-  review_file_diff:
-    required: false
-    description: 'The prompt for each file diff'
-    default: |
-      Here is the entire diff for `$filename` for context. Please use this context 
-      when reviewing patches.
+      Below is the format for diff patches. `---` 
+      separator is used between patches. 
 
+      <line_number>: 
+      ```text
+      <review comments on patch, if any>
+      ```
       ```diff
-      $file_diff
+      <patch>
       ```
+      ---
+      ...
 
-      Reply "OK" to confirm.
-  review_patch_begin:
-    required: false
-    description: 'The prompt for each file diff'
-    default: |
-      Next, I will send you a series of patches. Each patch consists of a diff snippet, 
-      and your task is to review every patch. Identify any bug risks or provide 
-      improvement suggestions. Otherwise, if the patch is acceptable, please reply 
-      "LGTM!" with a short comment. 
+      Patches for review -
 
-      Your responses will be recorded as review comments on the pull request. 
-      Markdown format is preferred for your responses. 
+      $patches
 
-      Reply "OK" to confirm.
-  review_patch:
-    required: false
-    description: 'The prompt for each chunks/patches'
-    default: |
-      $filename
+      Your review for each patch should be the following format 
+      with `---` separator between review comments. Make sure 
+      to use the line numbers exactly as provided above:
 
-      Existing comments on the patch, though some of them may be outdated. 
-      Please use them as additional context.
-      ```
-      $comment_chain
-      ```
+      <line_number>:
+      <review>
+      ---
+      ...
 
-      Diff for review:
-      ```diff
-      $patch
-      ```
-  comment_beginning:
+      Reflect on the provided code at least 3 times to identify any bug risks 
+      or provide improvement suggestions in these patches. 
+      You will point out potential issues such as security, logic errors, 
+      syntax errors, out of bound errors, data races, consistency, 
+      complexity, error handling, typos, grammar, code style, maintainability, 
+      performance, and so on. 
+
+      If there are no issues or suggestions and the patch is acceptable 
+      as-is, please include "LGTM!" (exact word) in your short 
+      review comment.
+
+      Your responses will be recorded as review comments on the 
+      pull request. Markdown format is preferred for your responses.
+  comment:
     required: false
     description: 'Prompt for comment'
     default: |
-      $system_message
-
       A comment was made on a review for a diff patch on file 
       `$filename`. I would like you to follow the instructions 
       in that comment. 
@@ -252,33 +226,18 @@ inputs:
       $summary
       ```
 
-      Reply "OK" to confirm.
-  comment_file:
-    required: false
-    description: 'Prompt for file'
-    default: |
-      Here is the content of `$filename` for context.
+      Here is the content of file.
 
       ```
       $file_content
       ```
 
-      Reply "OK" to confirm.
-  comment_file_diff:
-    required: false
-    description: 'Prompt for file diff'
-    default: |
-      Here is the entire diff for `$filename` for context.
+      Here is the entire diff.
 
       ```diff
       $file_diff
       ```
 
-      Reply "OK" to confirm.
-  comment:
-    required: false
-    description: 'Prompt for comment'
-    default: |
       I would like you to follow the instructions in the new 
       comment made on a conversation chain on a code review diff.