@@ -192,46 +192,50 @@ inputs:
192
192
Your review must consist of comments in the below format
193
193
with a separator between review comments. The format consists of
194
194
line number range and review comment applicable for that line
195
- number range. Any other commentary outside of this format will be ignored
195
+ number range. You can make multiple comments for each hunk.
196
+ Any other commentary outside of this format will be ignored
196
197
and will not be read by the parser. It's important that line number
197
198
ranges for each review must be within line number range of new_hunks.
198
199
Don't echo back the code provided to you as the
199
200
line number range is sufficient to map your comment to the relevant code
200
- section in GitHub. You can make multiple comments for each hunk and
201
- suggest new code that can replace code at those line number ranges.
201
+ section in GitHub.
202
202
203
- <start_line_number_in_new_hunk>-<end_line_number_in_new_hunk>:
204
- <your review>
203
+ Markdown format is preferred for text. Fenced code blocks should be
204
+ used for complete code suggestions that replace code at those
205
+ exact line number ranges -
206
+
207
+ <start_line_number>-<end_line_number>:
208
+ <review markdown>
209
+ ```suggestion
210
+ <replacement of code between start_line_number and end_line_number>
211
+ ```
212
+ ---
213
+ <start_line_number>-<end_line_number>:
214
+ <review markdown>
205
215
---
206
216
...
207
217
208
- Example:
218
+ Examples -
219
+
209
220
1-5:
210
221
LGTM!
211
222
---
212
223
6-6:
213
- LGTM!
224
+ ```suggestion
225
+ print "Hello!"
226
+ ```
214
227
---
215
228
216
- Reflect on the provided code at least 3 times and identify any
229
+ Reflect on the provided code thoroughly and identify substantive
217
230
bug risks or provide improvement suggestions in these changes.
218
- You will point out potential issues such as security, logic errors,
231
+ You will point out issues such as security, logic errors,
219
232
syntax errors, out of bound errors, data races, consistency,
220
233
complexity, error handling, typos, grammar, maintainability,
221
234
performance, and so on.
222
235
223
236
If there are no issues or suggestions and the change is acceptable
224
237
as-is, you must include the word `LGTM!` and make a short review comment.
225
238
226
- Markdown format is preferred for text. Fenced code blocks should be
227
- used for code suggestions that replace exact lines ranges -
228
-
229
- start-end:
230
- <review text in markdown>
231
- ```suggestion
232
- <replacement code between start and end lines>
233
- ```
234
- ---
235
239
comment :
236
240
required : false
237
241
description : ' Prompt for comment'
0 commit comments