Skip to content
This repository was archived by the owner on Mar 6, 2024. It is now read-only.

Commit 49da515

Browse files
authored
Update action.yml (#145)
1 parent 9af65fd commit 49da515

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

action.yml

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ inputs:
9999
performance, and so on.
100100
summarize_file_diff:
101101
required: false
102-
description: 'The prompt for the whole pull request'
102+
description: 'The prompt for file'
103103
default: |
104104
GitHub pull request title -
105105
`$title`
@@ -160,6 +160,8 @@ inputs:
160160
required: false
161161
description: 'The prompt for each file'
162162
default: |
163+
You will review a code change.
164+
163165
GitHub pull request title -
164166
`$title`
165167
@@ -173,31 +175,31 @@ inputs:
173175
$summary
174176
```
175177
176-
Here is the content of file `$filename` -
178+
Here is the content of file `$filename` for context -
177179
```
178180
$file_content
179181
```
180182
181183
Format for changes and review comments (if any) -
182184
183185
```new_hunk
184-
<new code with line numbers>
186+
<new code with line numbers for review>
185187
```
186188
187189
```old_hunk
188-
<old code>
190+
<old code for context>
189191
```
190192
191193
```comment_chain
192-
<existing review comments>
194+
<existing review comments for context>
193195
```
194196
---
195197
...
196198
197199
Changes for review -
198200
$patches
199201
200-
Your response must be of the format -
202+
Response format -
201203
202204
<start_line_number>-<end_line_number>:
203205
<review>
@@ -226,19 +228,18 @@ inputs:
226228
```
227229
---
228230
229-
Your response must consist of review comments in the above format
230-
with a separator between review comments. The format consists of
231-
line number range and review comment applicable for that line
232-
number range. Any other commentary outside of this format will be
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
233234
ignored and will not be read by the parser. It's important that
234-
line number ranges for each review comment must be within line
235-
number range of a new_hunk. Don't echo back the code provided to you as the
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
236237
line number range is sufficient to map your review comment to the
237238
relevant code section in GitHub. Markdown format is preferred for
238239
text. Fenced code blocks must be used for new code and replacement
239240
code suggestions. Code replacement suggestions must be complete,
240241
correctly formatted and most importantly, map exactly to the line
241-
number ranges that need to be replaced. If there are no issues or
242+
number ranges that need to be replaced inside the hunks. If there are no issues or
242243
suggestions and the hunk is acceptable as-is, your comment on the
243244
line ranges must include the word 'LGTM!'.
244245

0 commit comments

Comments
 (0)