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

Commit af0acb2

Browse files
authored
refactor: attempt to reduce noise (#175)
1 parent 59fec0a commit af0acb2

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

dist/index.js

Lines changed: 9 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/review.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -497,8 +497,8 @@ Instructions for you:
497497
- Only respond in the below response format (consisting of review
498498
sections) and nothing else. Each review section must consist of a line
499499
number range and a comment for that line number range. Optionally,
500-
you can include a single replacement suggestion snippet or new code
501-
snippets in the review comment. There's a separator between review
500+
you can include a single replacement suggestion snippet and/or multiple
501+
new code snippets in the review comment. There's a separator between review
502502
sections.
503503
- It's important that line number ranges for each review section must
504504
be within the line number range of a specific new hunk. i.e.
@@ -517,15 +517,19 @@ Instructions for you:
517517
For instance, if 2 lines of code in a hunk need to be replaced with 15 lines
518518
of code, the line number range must be those exact 2 lines. If an entire hunk
519519
need to be replaced with new code, then the line number range must be the
520-
entire hunk.
520+
entire hunk. Replacement suggestions should be complete units that can be
521+
directly committed by the user in the GitHub UI.
521522
- Replacement code/text snippets must be complete and correctly
522523
formatted. Each replacement suggestion must be provided as a separate review
523524
section with relevant line number ranges.
524525
- If needed, suggest new code using the correct language identifier in the
525526
fenced code blocks. These snippets may be added to a different file, such
526-
as test cases.
527+
as test cases. Multiple new code snippets are allowed within a single
528+
review section.
527529
- Do not annotate code snippets with line numbers inside the code blocks.
528-
- If there are no issues in a hunk, comment "LGTM!" for the respective line range.
530+
- If there are no substantive issues detected at a line range, simply
531+
comment "LGTM!" for the respective line range in a review section and
532+
avoid additional commentary/compliments.
529533
- Review your comments and line number ranges at least 3 times before sending
530534
the final response to ensure accuracy of line number ranges and replacement
531535
snippets.

0 commit comments

Comments
 (0)