Skip to content

feat: added more info in prompt for better code reviews #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sauravpanda merged 1 commit into from
Jun 18, 2024
Merged

feat: added more info in prompt for better code reviews #209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions kaizen/llms/prompts/code_review_prompts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,27 @@
- "Potential Issues"
- "Improvements"

Make sure to look for the following issues in the code logic:
[
"Syntax Errors",
"Logic Errors",
"Off-by-one Errors",
"Infinite Loops",
"Null or Undefined Values",
"Resource Leaks",
"Race Conditions",
"Integration Issues",
"Performance Issues",
"Security Vulnerabilities"
]

For "request_for_change", only make it true when topic is part of "Improvements" or "Potential Issues" or something which you think needs attention of the developer.

For "solution" make sure to point out whats wrong and how to fix it in current code. Try to be as precise as possible.

Generate all relevant and actionable feedback. Avoid duplicate feedbacks for same line, try to merge them.
For each piece of feedback, clearly reference the specific file(s) and line number(s) of code being addressed for each comment. Use markdown code blocks to quote relevant snippets of code when necessary.
Keep comments concise but make sure they have actionable points pointing to the code or line having the issue. Avoid duplicate feedback, merge when necessary.
Keep comments concise but make sure they have actionable and useful points pointing to the code or line having the issue. Avoid generic comments. Avoid duplicate feedback, merge when necessary.

If there is no feedback, return an empty JSON object: {{"review": []}}

Expand Down Expand Up @@ -94,11 +110,27 @@
- "Potential Issues"
- "Improvements"

Make sure to look for the following issues in the code logic:
[
"Syntax Errors",
"Logic Errors",
"Off-by-one Errors",
"Infinite Loops",
"Null or Undefined Values",
"Resource Leaks",
"Race Conditions",
"Integration Issues",
"Performance Issues",
"Security Vulnerabilities"
]

For "request_for_change", only make it true when topic is part of "Improvements" or "Potential Issues" or something which you think needs attention of the developer.

For "solution" make sure to point out whats wrong and how to fix it in current code. Try to be as precise as possible.

Generate all relevant and actionable feedback. Avoid duplicate feedbacks for same line, try to merge them.
For each piece of feedback, clearly reference the specific file(s) and line number(s) of code being addressed for each comment. Use markdown code blocks to quote relevant snippets of code when necessary.
Keep comments concise but make sure they have actionable points pointing to the code or line having the issue. Avoid duplicate feedback, merge when necessary.
Keep comments concise but make sure they have actionable and useful points pointing to the code or line having the issue. Avoid generic comments. Avoid duplicate feedback, merge when necessary.

If there is no feedback, return an empty JSON object: {{"review": []}}

Expand Down