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

Latest commit

 

History

History
202 lines (147 loc) · 11.7 KB

README.md

File metadata and controls

202 lines (147 loc) · 11.7 KB
Raw

Making pull requests less painful with an AI agent

GitHub license Discord GitHub

CodiumAI PR-Agent is an open-source tool aiming to help developers review pull requests faster and more efficiently. It automatically analyzes the pull request and can provide several types of commands:

‣ Auto Description (/describe): Automatically generating PR description - title, type, summary, code walkthrough and labels.
‣ Auto Review (/review): Adjustable feedback about the PR main theme, type, relevant tests, security issues, score, and various suggestions for the PR content.
‣ Question Answering (/ask ...): Answering free-text questions about the PR.
‣ Code Suggestions (/improve): Committable code suggestions for improving the PR.
‣ Update Changelog (/update_changelog): Automatically updating the CHANGELOG.md file with the PR changes.

See the usage guide for instructions how to run the different tools from CLI, or by online usage, as well as additional details on optional commands and configurations.

Example results:

/describe:

/review:

Overview

PR-Agent offers extensive pull request functionalities across various git providers:

GitHub Gitlab Bitbucket CodeCommit Azure DevOps Gerrit
TOOLS Review ✅ ✅ ✅ ✅ ✅ ✅
Ask ✅ ✅ ✅ ✅ ✅ ✅
Auto-Description ✅ ✅ ✅ ✅ ✅
Improve Code ✅ ✅ ✅ ✅
⮑ Extended ✅ ✅ ✅ ✅
Reflect and Review ✅ ✅ ✅
Update CHANGELOG.md ✅
USAGE CLI ✅ ✅ ✅ ✅ ✅
App / webhook ✅ ✅
Tagging bot ✅
Actions ✅
Web server ✅
CORE PR compression ✅ ✅ ✅ ✅ ✅ ✅
Repo language prioritization ✅ ✅ ✅ ✅ ✅ ✅
Adaptive and token-aware
file patch fitting		 ✅ ✅ ✅ ✅ ✅ ✅
Multiple models support ✅ ✅ ✅ ✅ ✅ ✅
Incremental PR Review ✅

Review the usage guide section for detailed instructions how to use the different tools, select the relevant git provider (GitHub, Gitlab, Bitbucket,...), and adjust the configuration file to your needs.

Try it now

You can try GPT-4 powered PR-Agent, on your public GitHub repository, instantly. Just mention @CodiumAI-Agent and add the desired command in any PR comment. The agent will generate a response based on your command. For example, add a comment to any pull request with the following text:

@CodiumAI-Agent /review

and the agent will respond with a review of your PR

Review generation process

To set up your own PR-Agent, see the Installation section below.

Installation

To get started with PR-Agent quickly, you first need to acquire two tokens:

  1. An OpenAI key from here, with access to GPT-4.
  2. A GitHub personal access token (classic) with the repo scope.

There are several ways to use PR-Agent:

How it works

The following diagram illustrates PR-Agent tools and their flow:

PR-Agent Tools

Check out the PR Compression strategy page for more details on how we convert a code diff to a manageable LLM prompt

Why use PR-Agent?

A reasonable question that can be asked is: "Why use PR-Agent? What make it stand out from existing tools?"

Here are some advantages of PR-Agent:

  • We emphasize real-life practical usage. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
  • Our PR Compression strategy is a core ability that enables to effectively tackle both short and long PRs.
  • Our JSON prompting strategy enables to have modular, customizable tools. For example, the '/review' tool categories can be controlled via the configuration file. Adding additional categories is easy and accessible.
  • We support multiple git providers (GitHub, Gitlab, Bitbucket, CodeCommit), multiple ways to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and multiple models (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
  • We are open-source, and welcome contributions from the community.

Roadmap

  • Support additional models, as a replacement for OpenAI (see here)
  • Develop additional logic for handling large PRs (see here)
  • Add additional context to the prompt. For example, repo (or relevant files) summarization, with tools such a ctags
  • PR-Agent for issues, and just for pull requests
  • Adding more tools. Possible directions:
    • PR description
    • Inline code suggestions
    • Reflect and review
    • Rank the PR (see here)
    • Enforcing CONTRIBUTING.md guidelines
    • Performance (are there any performance issues)
    • Documentation (is the PR properly documented)
    • ...

Similar Projects