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

Commit 53d5a34

Browse files
guritfaqguritfaq
authored
Update readme and renamed the repo (#375)
1 parent 37fa235 commit 53d5a34

File tree

1 file changed

+68
-58
lines changed

1 file changed

+68
-58
lines changed

‎README.md

Lines changed: 68 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1-
# OpenAI ChatGPT-based PR reviewer and summarizer
2-
3-
![AI](./docs/images/ai.png)
1+
## AI based PR reviewer and summarizer
2+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3+
<div>
4+
<a href="https://github.com/coderabbitai/openai-pr-reviewer)/commits/main">
5+
<img alt="GitHub" src="https://img.shields.io/github/last-commit/coderabbitai/openai-pr-reviewer/main?style=for-the-badge" height="20">
6+
</a>
7+
</div>
48

59
## Overview
610

7-
This [OpenAI ChatGPT-based](https://platform.openai.com/docs/guides/chat) GitHub
8-
Action provides a summary, release notes and review of pull requests. The unique
9-
features of this action are:
1011

11-
- **Line-by-line code change suggestions**: This action reviews the changes line
12+
CodeRabbit ai-pr-reviewer is an open-source project built on AI, designed to enhance developer productivity and efficiency by performing automated reviews of pull requests.
13+
Features:
14+
15+
- **PR Summerization**: It generates a summary and release notes of the changes in the pull request.
16+
- **Line-by-line code change suggestions**: Reviews the changes line
1217
by line and provides code change suggestions that can be directly committed
1318
from the GitHub UI.
1419
- **Continuous, incremental reviews**: Reviews are performed on each commit
@@ -32,15 +37,18 @@ features of this action are:
3237
`summarize_release_notes` prompts to focus on specific aspects of the review
3338
process or even change the review objective.
3439

35-
# Professional Version of CodeRabbit <br/>
36-
37-
The professional version of our openai-pr-reviewer project is now live at
38-
[coderabbit.ai](http://Coderabbit.ai). Building upon our open-source foundation,
39-
CodeRabbit offers improved features, dedicated support, and our ongoing
40-
commitment to superior code reviews.
40+
To use this tool, you need to add the provided YAML file to your repository and configure the required environment variables, such as GITHUB_TOKEN and OPENAI_API_KEY.
41+
For more information on usage, examples, contributing, and FAQs, you can refer to the sections below.
4142

42-
## Usage
43+
- [Overview](#overview)
44+
- [Install](#instal)
45+
- [Conversation with OpenAI](#Conversation-with-OpenAI)
46+
- [Examples](#examples)
47+
- [Contribute](#contribute)
48+
- [FAQs](#FAQs)
4349

50+
## Install
51+
ai-pr-reviewer runs as a GitHub Action.
4452
Add the below file to your repository at
4553
`.github/workflows/openai-pr-reviewer.yml`
4654

@@ -67,7 +75,7 @@ jobs:
6775
review:
6876
runs-on: ubuntu-latest
6977
steps:
70-
- uses: coderabbitai/openai-pr-reviewer@v1
78+
- uses: fluxninja/openai-pr-reviewer@latest
7179
env:
7280
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7381
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
@@ -77,38 +85,6 @@ jobs:
7785
review_comment_lgtm: false
7886
```
7987
80-
### Conversation with OpenAI
81-
82-
You can reply to a review comment made by this action and get a response based
83-
on the diff context. Additionally, you can invite the bot to a conversation by
84-
tagging it in the comment (`@openai`).
85-
86-
Example:
87-
88-
> @openai Please generate a test plan for this file.
89-
90-
Note: A review comment is a comment made on a diff or a file in the pull
91-
request.
92-
93-
### Ignoring PRs
94-
95-
Sometimes it is useful to ignore a PR. For example, if you are using this action
96-
to review documentation, you can ignore PRs that only change the documentation.
97-
To ignore a PR, add the following keyword in the PR description:
98-
99-
```text
100-
@openai: ignore
101-
```
102-
103-
### Screenshots
104-
105-
![PR Summary](./docs/images/openai-pr-summary.png)
106-
107-
![PR Release Notes](./docs/images/openai-pr-release-notes.png)
108-
109-
![PR Review](./docs/images/openai-pr-review.png)
110-
111-
![PR Conversation](./docs/images/openai-review-conversation.png)
11288
11389
#### Environment variables
11490
@@ -123,7 +99,7 @@ To ignore a PR, add the following keyword in the PR description:
12399

124100
### Models: `gpt-4` and `gpt-3.5-turbo`
125101

126-
At FluxNinja, we use `gpt-3.5-turbo` for lighter tasks such as summarizing the
102+
Recommend using `gpt-3.5-turbo` for lighter tasks such as summarizing the
127103
changes (`openai_light_model` in configuration) and `gpt-4` for more complex
128104
review and commenting tasks (`openai_heavy_model` in configuration).
129105

@@ -149,14 +125,8 @@ system_message: |
149125
infrastructure.
150126

151127
Company context -
152-
FluxNinja is a cloud-native intelligent load management platform.
153-
The platform is powered by Aperture, an open-source project, which
154-
provides a control systems inspired policy language for defining
155-
observability driven control loop. FluxNinja's load management,
156-
such as prioritized load shedding and load-based autoscaling,
157-
ensures system stability. FluxNinja ARC, the commercial solution,
158-
offers advanced analytics, intelligent alerting, and policy
159-
visualization.
128+
CodeRabbit is an AI-powered Code reviewer.It boosts code quality and cuts manual effort. Offers context-aware, line-by-line feedback, highlights critical changes,
129+
enables bot interaction, and lets you commit suggestions directly from GitHub.
160130

161131
When reviewing or generating content focus on key areas such as -
162132
- Accuracy
@@ -176,10 +146,49 @@ system_message: |
176146
177147
</details>
178148
149+
150+
## Conversation with OpenAI
151+
152+
You can reply to a review comment made by this action and get a response based
153+
on the diff context. Additionally, you can invite the bot to a conversation by
154+
tagging it in the comment (`@openai`).
155+
156+
Example:
157+
158+
> @openai Please generate a test plan for this file.
159+
160+
Note: A review comment is a comment made on a diff or a file in the pull
161+
request.
162+
163+
### Ignoring PRs
164+
165+
Sometimes it is useful to ignore a PR. For example, if you are using this action
166+
to review documentation, you can ignore PRs that only change the documentation.
167+
To ignore a PR, add the following keyword in the PR description:
168+
169+
```text
170+
@openai: ignore
171+
```
172+
173+
174+
## Examples
175+
Some of the reviews done by pr-reviewer
176+
177+
![PR Summary](./docs/images/openai-pr-summary.png)
178+
179+
![PR Release Notes](./docs/images/openai-pr-release-notes.png)
180+
181+
![PR Review](./docs/images/openai-pr-review.png)
182+
183+
![PR Conversation](./docs/images/openai-review-conversation.png)
184+
179185
Any suggestions or pull requests for improving the prompts are highly
180186
appreciated.
181187

182-
## Developing
188+
189+
## Contribute
190+
191+
### Developing
183192

184193
> First, you'll need to have a reasonably modern version of `node` handy, tested
185194
> with node 16.
@@ -196,6 +205,7 @@ Build the typescript and package it for distribution
196205
$ npm run build && npm run package
197206
```
198207

208+
199209
## FAQs
200210

201211
### Review pull requests from forks
@@ -229,7 +239,7 @@ jobs:
229239
review:
230240
runs-on: ubuntu-latest
231241
steps:
232-
- uses: coderabbitai/openai-pr-reviewer@v1
242+
- uses: fluxninja/openai-pr-reviewer@latest
233243
env:
234244
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
235245
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

0 commit comments

Comments
 (0)