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

Commit

Permalink
openai -> coderabbit (#389)
Browse files Browse the repository at this point in the history
  • Loading branch information
harjotgill authored Jul 30, 2023
1 parent 30fe6ba commit 7a85248
Show file tree
Hide file tree
Showing 6 changed files with 205 additions and 77 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

<div>
<a href="https:/coderabbitai/openai-pr-reviewer)/commits/main">
<img alt="GitHub" src="https://img.shields.io/github/last-commit/coderabbitai/openai-pr-reviewer/main?style=for-the-badge" height="20">
<a href="https:/coderabbitai/ai-pr-reviewer)/commits/main">
<img alt="GitHub" src="https://img.shields.io/github/last-commit/coderabbitai/ai-pr-reviewer/main?style=for-the-badge" height="20">
</a>
</div>

Expand Down Expand Up @@ -47,15 +47,15 @@ FAQs, you can refer to the sections below.

- [Overview](#overview)
- [Install instructions](#install-instructions)
- [Conversation with OpenAI](#conversation-with-openai)
- [Conversation with CodeRabbit](#conversation-with-coderabbit)
- [Examples](#examples)
- [Contribute](#contribute)
- [FAQs](#faqs)

## Install instructions

`ai-pr-reviewer` runs as a GitHub Action. Add the below file to your repository
at `.github/workflows/openai-pr-reviewer.yml`
at `.github/workflows/ai-pr-reviewer.yml`

```yaml
name: Code Review
Expand Down Expand Up @@ -123,7 +123,7 @@ value. For example, to review docs/blog posts, you can use the following prompt:

```yaml
system_message: |
You are `@openai` (aka `github-actions[bot]`), a language model
You are `@coderabbitai` (aka `github-actions[bot]`), a language model
trained by OpenAI. Your purpose is to act as a highly experienced
DevRel (developer relations) professional with focus on cloud-native
infrastructure.
Expand All @@ -150,15 +150,15 @@ system_message: |
</details>
## Conversation with OpenAI
## Conversation with CodeRabbit
You can reply to a review comment made by this action and get a response based
on the diff context. Additionally, you can invite the bot to a conversation by
tagging it in the comment (`@openai`).
tagging it in the comment (`@coderabbitai`).

Example:

> @openai Please generate a test plan for this file.
> @coderabbitai Please generate a test plan for this file.

Note: A review comment is a comment made on a diff or a file in the pull
request.
Expand All @@ -170,7 +170,7 @@ to review documentation, you can ignore PRs that only change the documentation.
To ignore a PR, add the following keyword in the PR description:

```text
@openai: ignore
@coderabbitai: ignore
```

## Examples
Expand Down
10 changes: 5 additions & 5 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: 'OpenAI ChatGPT based PR Reviewer & Summarizer'
description: 'OpenAI ChatGPT based PR Reviewer and Summarizer'
name: 'AI-based PR Reviewer & Summarizer with Chat Capabilities'
description: 'AI-based PR Reviewer & Summarizer with Chat Capabilities'
branding:
icon: 'aperture'
icon: 'git-merge'
color: 'orange'
author: 'FluxNinja, Inc.'
author: 'CodeRabbit LLC'
inputs:
debug:
required: false
Expand Down Expand Up @@ -148,7 +148,7 @@ inputs:
required: false
description: 'System message to be sent to OpenAI'
default: |
You are `@openai` (aka `github-actions[bot]`), a language model
You are `@coderabbitai` (aka `github-actions[bot]`), a language model
trained by OpenAI. Your purpose is to act as a highly experienced
software engineer and provide a thorough review of the code hunks
and suggest code snippets to improve key areas such as:
Expand Down
116 changes: 86 additions & 30 deletions dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 7a85248

Please sign in to comment.