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

Commit 6d70e9b

Browse files
authored
update prompt (#77)
<!-- This is an auto-generated comment: release notes by openai --> ### Summary by OpenAI Documentation: This pull request updates the prompt message and default value of `max_files` input in `action.yml`, adds a note about review comments in pull requests to `README.md`, and clarifies how to interact with the bot in the tips section of `src/review.ts`. These changes aim to improve the user experience and provide better guidance on how to use the bot effectively. <!-- end of auto-generated comment: release notes by openai -->
1 parent 1b9c743 commit 6d70e9b

File tree

4 files changed

+11
-6
lines changed

4 files changed

+11
-6
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ Example:
7474

7575
> @openai Can you please review this block of code?
7676

77+
Note: A review comment is a comment made on a diff or a file in the pull
78+
request.
79+
7780
### Screenshots
7881

7982
![PR Summary](./docs/images/openai-pr-summary.png)

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ inputs:
1212
max_files:
1313
required: false
1414
description: 'Max files to review. Less than or equal to 0 means no limit.'
15-
default: '60'
15+
default: '50'
1616
review_comment_lgtm:
1717
required: false
1818
description: 'Leave comments even if the patch is LGTM'
@@ -189,7 +189,7 @@ inputs:
189189
default: |
190190
Next, I will send you a series of patches. Each patch consists of a diff snippet,
191191
and your task is to review every patch. Identify any bug risks or provide
192-
improvement suggestions. If the patch looks good and acceptable, please reply
192+
improvement suggestions. Otherwise, if the patch is acceptable, please reply
193193
"LGTM!" with a short comment.
194194
195195
Your responses will be recorded as review comments on the pull request.

dist/index.js

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

src/review.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,9 @@ ${filename}: ${summary}
227227
---
228228
229229
Tips:
230-
- Reply on the review comment left by this bot to ask follow-up questions.
231-
- Invite the bot into a review conversation by typing \`@openai\` in the beginning of the comment.
230+
- Reply on review comments left by this bot to ask follow-up questions.
231+
A review comment is a comment on a diff or a file.
232+
- Invite the bot into a review comment chain by tagging \`@openai\` in a reply.
232233
`
233234

234235
next_summarize_ids = summarize_final_response_ids

0 commit comments

Comments
 (0)