Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vhenri authored Dec 6, 2023
1 parent a7943c0 commit cb8a499
Showing 1 changed file with 5 additions and 29 deletions.
34 changes: 5 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Overview

CodeRabbit `ai-pr-reviewer` is an AI-based code reviewer and summarizer for
CodeGuardian is a fork of CodeRabbit `ai-pr-reviewer`. It is an AI-based code reviewer and summarizer for
GitHub pull requests using OpenAI's `gpt-3.5-turbo` and `gpt-4` models. It is
designed to be used as a GitHub Action and can be configured to run on every
pull request and review comments
Expand Down Expand Up @@ -44,22 +44,13 @@ configure the required environment variables, such as `GITHUB_TOKEN` and
FAQs, you can refer to the sections below.

- [Overview](#overview)
- [Professional Version of CodeRabbit](#professional-version-of-coderabbit)
- [Reviewer Features](#reviewer-features)
- [Install instructions](#install-instructions)
- [Conversation with CodeRabbit](#conversation-with-coderabbit)
- [Examples](#examples)
- [Contribute](#contribute)
- [FAQs](#faqs)

## CodeRabbit Pro

The professional version of `openai-pr-reviewer` project is now available at
[coderabbit.ai](http://coderabbit.ai). Building upon our open source foundation,
CodeRabbit Pro offers premium features including enhanced context and superior
noise reduction, dedicated support, and our ongoing commitment to improve code
reviews. Moreover, CodeRabbit Pro is free for open source projects.

## Install instructions

`ai-pr-reviewer` runs as a GitHub Action. Add the below file to your repository
Expand Down Expand Up @@ -158,15 +149,15 @@ system_message: |
</details>
## Conversation with CodeRabbit
## Conversation with Code Guardian
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 (`@coderabbitai`).
tagging it in the comment (`@codeguardianai`).

Example:

> @coderabbitai Please generate a test plan for this file.
> @codeguardianai 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 @@ -178,24 +169,9 @@ 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
@coderabbitai: ignore
@codeguardianai: ignore
```

## Examples

Some of the reviews done by ai-pr-reviewer

![PR Summary](./docs/images/PRSummary.png)

![PR Release Notes](./docs/images/ReleaseNotes.png)

![PR Review](./docs/images/section-1.png)

![PR Conversation](./docs/images/section-3.png)

Any suggestions or pull requests for improving the prompts are highly
appreciated.

## Contribute

### Developing
Expand Down

0 comments on commit cb8a499

Please sign in to comment.