@@ -181,17 +181,14 @@ inputs:
181
181
```
182
182
183
183
Format for changes and review comments (if any) -
184
-
185
- ```new_hunk
186
- <new code with line numbers for review>
184
+ ```new_hunk_for_review
185
+ <new code with line numbers>
187
186
```
188
-
189
- ```old_hunk
190
- <old code for context>
187
+ ```old_hunk_for_context
188
+ <old code>
191
189
```
192
-
193
- ```comment_chain
194
- <existing review comments for context>
190
+ ```comment_chains_for_context
191
+ <comment chains>
195
192
```
196
193
---
197
194
...
@@ -200,7 +197,6 @@ inputs:
200
197
$patches
201
198
202
199
Response format -
203
-
204
200
<start_line_number>-<end_line_number>:
205
201
<review>
206
202
```suggestion
@@ -217,32 +213,39 @@ inputs:
217
213
```
218
214
...
219
215
220
- Example -
221
-
216
+ Example response -
222
217
1-5:
223
218
LGTM!
224
219
---
225
220
6-6:
226
221
```suggestion
227
222
print("Hello!")
228
223
```
224
+ ```go
225
+ log.Info().Msgf("Example")
226
+ ```
229
227
---
230
228
231
- Your response must be in the above format. Each review section consists of a
232
- line number range and a review comment applicable for that line
233
- number range. There is a separator between review sections. Any other text outside of this format will be
234
- ignored and will not be read by the parser. It's important that
235
- line number ranges for each review section must be within line
236
- number range of a specific new hunk. Don't echo back the code provided to you as the
237
- line number range is sufficient to map your review comment to the
238
- relevant code section in GitHub. Markdown format is preferred for
239
- text. Fenced code blocks must be used for new code and replacement
240
- code suggestions. Code replacement suggestions must be complete,
241
- correctly formatted and most importantly, map exactly to the line
242
- number ranges that need to be replaced inside the hunks. If there are no issues or
243
- suggestions and the hunk is acceptable as-is, your comment on the
244
- line ranges must include the word 'LGTM!'.
245
-
229
+ 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.
235
+ - 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.
242
+ - Markdown format is preferred for text.
243
+ - Fenced code blocks must be used for new code and replacement
244
+ code suggestions. Code replacement suggestions must be complete,
245
+ correctly formatted and most importantly, map exactly to the line
246
+ number ranges that need to be replaced inside the hunks.
247
+ - If there are no issues or suggestions and the hunk is acceptable as-is,
248
+ your comment on the line ranges must include the word 'LGTM!'.
246
249
comment :
247
250
required : false
248
251
description : ' Prompt for comment'
@@ -279,10 +282,10 @@ inputs:
279
282
$diff
280
283
```
281
284
282
- The format of the conversation chain is -
285
+ The format of a comment in the chain is -
283
286
`user: comment`
284
287
285
- Conversation chain (including the new comment) -
288
+ Comment chain (including the new comment) -
286
289
```
287
290
$comment_chain
288
291
```
0 commit comments