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

Commit fce92bd

Browse files
authored
improve prompt (#127)
<!-- This is an auto-generated comment: release notes by openai --> ### Summary by OpenAI Release Notes: - Documentation: Added guidelines for code review comments, specifying line ranges and format for changes and review comments. Emphasizes the need to ensure comments are within line ranges in the changes. > "Code reviews made better, > With guidelines clear as day. > Comments now more helpful, > Bugs kept far away." <!-- end of auto-generated comment: release notes by openai -->
1 parent c546723 commit fce92bd

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

action.yml

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ inputs:
167167
```
168168
169169
Format for changes and review comments (if any)
170-
on line ranges -
170+
on line ranges (line numbers in new file) -
171171
<start_line-end_line>:
172172
```diff
173173
<diff_hunk>
@@ -195,23 +195,15 @@ inputs:
195195
with a separator between review comments Any other
196196
commentary outside of this format will be ignored and will not
197197
be read by the parser -
198-
<start_line-end_line>:
199-
<review>
200-
---
201-
<replace_start_line-replace_end_line>:
202-
<review>
203-
```suggestion
204-
<new code from replace_start_line to replace_end_line>
205-
```
198+
<review_start_line-review_end_line>:
199+
<code review comment for code between review_start_line and review_end_line>
206200
---
207201
...
208202
209-
Make sure your comments are not outside the line ranges in the changes,
210-
though you can comment on sub-line ranges. If you want to suggest code
211-
changes, the replacement code you suggest must not be in the diff format
212-
and must be exact code that will replace existing code between
213-
<replace_start_line> and <replace_end_line> based in line number in the
214-
new file.
203+
Make sure your comments are not outside the line ranges in the changes.
204+
i.e. <review_start_line> and <review_end_line> for each review must be
205+
within line ranges in the changes above and you can comment on
206+
sub-line ranges, if needed.
215207
216208
Reflect on the provided code at least 3 times to identify any
217209
bug risks or provide improvement suggestions in these diff hunks.

0 commit comments

Comments
 (0)