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

Commit 889ea5e

Browse files
authored
update prompt to further reduce noise (#201)
<!-- This is an auto-generated comment: release notes by openai --> ### Summary by OpenAI ### Release Notes - Documentation: Clarified instructions for code review to reduce noise and improve the review process. > "Code review made better, > With clearer instructions to fetter. > Noise reduced, issues highlighted, > Reviewers can now be more delighted." <!-- end of auto-generated comment: release notes by openai -->
1 parent 8930f9f commit 889ea5e

File tree

3 files changed

+15
-12
lines changed

3 files changed

+15
-12
lines changed

action.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,11 @@ inputs:
102102
- Complexity
103103
- Optimization
104104
105-
Refrain from addressing minor code style issues, compliments, or missing
106-
comments/documentation, unless explicitly requested. Concentrate on
107-
identifying and resolving significant concerns to improve overall code
108-
quality while deliberately disregarding minor issues.
105+
Refrain from commenting on minor code style issues, missing
106+
comments/documentation, or giving compliments, unless explicitly
107+
requested. Concentrate on identifying and resolving significant
108+
concerns to improve overall code quality while deliberately
109+
disregarding minor issues.
109110
summarize_file_diff:
110111
required: false
111112
description: 'The prompt for file'

dist/index.js

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

src/review.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,8 @@ Important instructions:
412412
<end_line_number>. The line number range is sufficient to map your
413413
comment to the code changes in GitHub pull request.
414414
- Consider the context provided by the old hunk and associated comment
415-
chain when reviewing the new hunk.
415+
chain when reviewing the new hunk. Do not summarize the changes in the
416+
review comment and only focus on pointing out substantive issues.
416417
- Use Markdown format for review comment text.
417418
- Fenced code blocks must be used for new content and replacement
418419
code/text snippets and must not be annotated with line numbers.
@@ -432,9 +433,9 @@ Important instructions:
432433
fenced code blocks. These snippets may be added to a different file, such
433434
as test cases. Multiple new code snippets are allowed within a single
434435
review section.
435-
- If there are no substantive issues detected at a line range, simply
436-
comment "LGTM!" for the respective line range in a review section and
437-
avoid additional commentary/compliments.
436+
- If there are no substantive issues detected at a line range and/or the
437+
implementation looks good, you must respond with the comment "LGTM!" and
438+
nothing else for the respective line range in a review section.
438439
- Reflect on your comments and line number ranges before sending the final
439440
response to ensure accuracy of line number ranges and replacement
440441
snippets.

0 commit comments

Comments
 (0)