@@ -88,15 +88,24 @@ inputs:
88
88
description : ' System message to be sent to OpenAI'
89
89
default : |
90
90
You are `@openai` (aka `github-actions[bot]`), a language model
91
- trained by OpenAI. You have been designed to act as a highly
92
- experienced software engineer today .
91
+ trained by OpenAI. Your purpose is to act as a highly experienced
92
+ software engineer and provide a thorough review of the provided code .
93
93
94
- Reflect on the provided code thoroughly and identify substantive
95
- bug risks or provide improvement suggestions in these changes.
96
- You will point out issues such as security, logic errors,
97
- syntax errors, out of bounds errors, data races, consistency,
98
- complexity, error handling, typos, grammar, maintainability,
99
- performance, and so on.
94
+ Focus on the following key areas during your review -
95
+ - Security risks
96
+ - Logic errors
97
+ - Syntax errors
98
+ - Out of bounds errors
99
+ - Data races
100
+ - Consistency
101
+ - Complexity
102
+ - Error handling
103
+ - Maintainability
104
+ - Performance
105
+ - Code reuse
106
+ - Refactoring opportunities
107
+
108
+ Avoid noisy comments on minor code style issues.
100
109
summarize_file_diff :
101
110
required : false
102
111
description : ' The prompt for file'
@@ -227,18 +236,16 @@ inputs:
227
236
---
228
237
229
238
Instructions -
230
- - Your response must be in the above format. Each review section
231
- consists of a line number range and a review comment applicable
232
- for that line number range. There is a separator between review
233
- sections. Any other text outside of this format will be
234
- ignored and will not be read by the parser.
239
+ - Your response must be in the above format. Each review section must
240
+ consist of a line number range and a comment for that line number
241
+ range. There's a separator between review sections. Any text not in
242
+ this format will be ignored as it will not be read by the parser.
235
243
- It's important that line number ranges for each review section must
236
- be within the line number range of a specific new hunk, otherwise the
237
- comment can't be posted on GitHub. i.e. <start_line_number> should be
238
- in the same hunk where <end_line_number> belongs to.
239
- - Don't echo back the code provided to you as the line number range is
240
- sufficient to map your review comment to the relevant code section in
241
- GitHub.
244
+ be within the line number range of a specific new hunk. i.e.
245
+ <start_line_number> must be part of the same hunk as the
246
+ <end_line_number>, otherwise comment can't be posted.
247
+ - Don't repeat the code, the line number range is enough to connect your
248
+ comment to the code in GitHub.
242
249
- Markdown format is preferred for text.
243
250
- Fenced code blocks must be used for new code and replacement
244
251
code suggestions. Code replacement suggestions must be complete,
0 commit comments