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

Commit 755eca2

Browse files
committed
update docs
1 parent de3883d commit 755eca2

File tree

6 files changed

+18
-4
lines changed

6 files changed

+18
-4
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# ChatGPT based PR reviewer and summarizer
22

3-
Based on [ChatGPT Action](https://github.com/unsafecoerce/chatgpt-pr-reviewer)
4-
by [Tao He](https://github.com/sighingnow).
5-
63
## Overview
74

5+
This [ChatGPT](https://platform.openai.com/docs/guides/chat) based GitHub Action provides a summary, release notes and review of pull requests. The prompts have been tuned for concise response. To prevent excessive notifications, this action can be configured to skip adding review comments when the changes look good for the most part.
6+
87
### Features
98

109
- Code review your pull requests
@@ -51,6 +50,14 @@ jobs:
5150
review_comment_lgtm: true
5251
```
5352
53+
### Screenshots
54+
55+
![PR Summary](./docs/images/chatgpt-pr-summary.png)
56+
57+
![PR Release Notes](./docs/images/chatgpt-pr-release-notes.png)
58+
59+
![PR Review](./docs/images/chatgpt-pr-review.png)
60+
5461
### Configuration
5562
5663
See also: [./action.yml](./action.yml)
@@ -163,3 +170,10 @@ Set `debug: true` in the workflow file to enable debug mode, which will show the
163170

164171
[1]: https://github.com/marketplace?type=&verification=&query=chatgpt-pr-reviewer+
165172
[2]: https://www.npmjs.com/package/chatgpt
173+
174+
### Special Thanks
175+
176+
This GitHub Action is based on
177+
[ChatGPT Action](https://github.com/unsafecoerce/chatgpt-pr-reviewer)
178+
by [Tao He](https://github.com/sighingnow).
179+

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ inputs:
4949
default: https://chat.duti.tech/api/conversation
5050
review_comment_lgtm:
5151
required: false
52-
description: 'Leave comments even the patch is LGTM'
52+
description: 'Leave comments even if the patch is LGTM'
5353
default: false
5454
review_beginning:
5555
required: false

docs/images/chatgpt-example.jpg

-283 KB
Binary file not shown.
37.6 KB
Loading

docs/images/chatgpt-pr-review.png

125 KB
Loading

docs/images/chatgpt-pr-summary.png

204 KB
Loading

0 commit comments

Comments
 (0)