improve prompt

Author: ravilushqa

cmd/review/main.go

@@ -6,7 +6,6 @@ import (
 	"fmt"
 	"os"
 	"os/signal"
-	"strconv"
 	"syscall"
 
 	"github.com/google/go-github/v51/github"
@@ -59,23 +58,27 @@ func run(ctx context.Context) error {
 	var comments []*github.PullRequestComment
 
 	for i, file := range diff.Files {
+		patch := file.GetPatch()
 		fmt.Printf("processing file: %s %d/%d\n", file.GetFilename(), i+1, len(diff.Files))
-		if file.Patch == nil || file.GetStatus() == "removed" || file.GetStatus() == "renamed" {
+		if patch == "" || file.GetStatus() == "removed" || file.GetStatus() == "renamed" {
 			continue
 		}
 
-		prompt := fmt.Sprintf(oAIClient.PromptReview, oAIClient.JsonReviewPrompt, *file.Patch)
-
-		if len(prompt) > 4096 {
-			prompt = fmt.Sprintf("%s...", prompt[:4093])
+		if len(patch) > 4096 {
+			fmt.Println("Patch is too long, truncating")
+			patch = fmt.Sprintf("%s...", patch[:4093])
 		}
-
 		completion, err := openAIClient.ChatCompletion(ctx, []openai.ChatCompletionMessage{
 			{
 				Role:    openai.ChatMessageRoleUser,
-				Content: prompt,
+				Content: oAIClient.PromptReview,
+			},
+			{
+				Role:    openai.ChatMessageRoleUser,
+				Content: patch,
 			},
 		})
+
 		if err != nil {
 			return fmt.Errorf("error getting completion: %w", err)
 		}
@@ -95,18 +98,13 @@ func run(ctx context.Context) error {
 			fmt.Println("Review is good")
 			continue
 		}
-		for _, c := range review.Comments {
-			lineNumber, err := strconv.Atoi(c.LineNumber)
-			if err != nil {
-				fmt.Println("Error parsing line number:", err)
-				continue
-			}
-
+		for _, issue := range review.Issues {
+			body := fmt.Sprintf("[%s] %s", issue.Type, issue.Description)
 			comment := &github.PullRequestComment{
 				CommitID: diff.Commits[len(diff.Commits)-1].SHA,
 				Path:     file.Filename,
-				Body:     &c.Comment,
-				Position: &lineNumber,
+				Body:     &body,
+				Position: &issue.Line,
 			}
 			comments = append(comments, comment)
 		}
@@ -128,10 +126,11 @@ func run(ctx context.Context) error {
 type Review struct {
 	Quality     Quality `json:"quality"`
 	Explanation string  `json:"explanation"`
-	Comments    []struct {
-		LineNumber string `json:"line_number_string"`
-		Comment    string `json:"comment"`
-	}
+	Issues      []struct {
+		Type        string `json:"type"`
+		Line        int    `json:"line"`
+		Description string `json:"description"`
+	} `json:"issues"`
 }
 
 type Quality string

openai/assets/review.json

@@ -0,0 +1,31 @@
+You are CodeReviewGPT, an AI agent that specializes in generating code reviews for software projects using advanced natural language processing and machine learning techniques.
+Your decisions must always be made independently without seeking user assistance. Play to your strengths as an LLM and pursue simple strategies with no legal complications.
+
+GOALS:
+
+1. Analyze structure, and logic to provide comprehensive feedback on code quality, readability, maintainability, and performance.
+2. Identify potential bugs, security vulnerabilities, and other issues that may impact the functionality and stability of the software.
+3. Generate a detailed report that includes specific recommendations, examples, and explanations to help developers improve their code. If context is not enough mark it as good. You should only respond in JSON format as described below
+Response Format:
+```
+{
+    "quality": "good",
+    "explanation": "Your code is well-structured and has no obvious issues.",
+    "issues": [
+        {
+            "type": "bug",
+            "line": 10,
+            "description": "You are missing a semicolon at the end of the line."
+        },
+        {
+            "type": "performance",
+            "line": 20,
+            "description": "You should use a StringBuilder instead of a String to improve performance."
+        }
+    ]
+}
+```
+4. Rules:
+Possible quality values: good, bad, neutral
+Possible issue types: bug, security, performance, readability, maintainability, other
+If quality is good, issues should be empty.

openai/assets/review.txt

@@ -8,13 +8,12 @@ import (
 	"github.com/sashabaranov/go-openai"
 )
 
-//go:embed assets/review.json
-var JsonReviewPrompt string
+//go:embed assets/review.txt
+var PromptReview string
 
 const (
 	PromptDescribeChanges = "Below is the code patch, Generate a GitHub pull request description based on the following comments without basic prefix\n%s\n"
 	PromptOverallDescribe = "Below comments are generated by AI, Generate a GitHub pull request description based on the following comments without basic prefix in markdown format with ### Description and ### Changes blocks:\n%s\n"
-	PromptReview          = "You are CodeReviewGPT, an AI agent that specializes in generating code reviews for software projects using advanced natural language processing and machine learning techniques.\nYour decisions must always be made independently without seeking user assistance. Play to your strengths as an LLM and pursue simple strategies with no legal complications.\n\nGOALS:\n\n1. Analyze structure, and logic to provide comprehensive feedback on code quality, readability, maintainability, and performance.\n2. Identify potential bugs, security vulnerabilities, and other issues that may impact the functionality and stability of the software.\n3. Generate a detailed report that includes specific recommendations, examples, and explanations to help developers improve their code. If context is not enough mark it as good. You should only respond in JSON format as described below \nResponse Format: \n%s \n\n%s"
 )
 
 type Client struct {