Product
PR Review

Archie AI PR Review Feature Documentation

Overview

Archie AI provides an intelligent PR Review feature that integrates seamlessly with GitHub and GitLab repositories. This feature helps streamline the code review process by offering automated reviews, code suggestions, and interactive walkthroughs.

Key Features

  • Automated PR Review: Generate comprehensive reviews for pull requests.
  • Code Suggestions: Receive code improvement suggestions.
  • Interactive Walkthrough: Get a step-by-step walkthrough of the changes in a pull request.
  • Customizable Commands: Use various commands to interact with Archie AI.
  • Similar Issue Finder: Find issues related to the current PR. [Experimental]
  • Turbo Review: Advanced, fully-agentic PR review analyzing multiple factors in parallel. [Experimental]

Available Commands

You can interact with Archie AI using the following commands. You can use either the @archieai prefix or the shorter / prefix for each command.

  • @archieai help (or /help): Show the help message.
  • @archieai ask [question] (or /ask [question]): Ask a question about the PR.
  • @archieai describe (or /describe): Generate a description of the PR.
  • @archieai walkthrough (or /walkthrough): Generate an interactive walkthrough of the PR changes.
  • @archieai complete-review (or /complete-review): Generate a complete review of the pull request.
  • @archieai incremental_review (or /incremental-review): Generate an incremental review of new changes since the last review.
  • @archieai find-similar-issue (or /find-similar-issue): Find and display issues similar to the current PR. [Experimental]
  • @archieai turbo-review (or /turbo-review): Perform a Turbo Review, an advanced and fully-agentic PR review. [Experimental]

Example Usage

  • To generate a complete review of a pull request, comment the following on the PR: @archieai complete-review Or /complete-review

  • To ask a question about a specific part of the PR, comment: @archieai ask What is the purpose of this function?or /ask What is the purpose of this function?

Setup

Follow these steps to set up Archie AI for your GitHub repositories:

  1. Install Archie AI Application in your GitHub Repo:

  2. Setup Configuration: Configure the settings for each repository where you want to use Archie AI.

Setup Configuration

Archie AI allows you to customize the review settings based on your preferences. Here are the available configuration settings:

  • Review every PR on Open: Enable or disable automated PR reviews. Default is False.
  • Auto-update the PR summary and title: Automatically update the PR summary and title based on the review. Default is False.
  • Inline code improvement suggestion: Enable or disable code improvement suggestions. Default is False.
  • Ask question about PR: Allow users to ask questions about the PR. Default is False.
  • Create interactive walkthrough of changes in PR: Enable or disable interactive walkthroughs of the PR changes. Default is False.
  • Ignore bot generated PR: Ignore pull requests created by bots. Default is False.
  • Exclude prefix: A list of PR title prefixes to ignore. Default is an empty list [].
  • Additional instruction: Any special instructions or configurations for the PR review. Default is None.

Visit the PR Review Page (opens in a new tab) to update your configuration settings.

Examples of Archie AI's PR Review

  1. Archie AI caught a critical issue in our code where it identified missing fallback logic, which could lead to potential misconfigurations. This kind of insight helps developers catch subtle but impactful errors, ensuring more reliable code.
Setup Configuration
  1. Archie AI identified a critical issue in our async code where using asyncio.sleep(0) could lead to unexpected behavior under heavy load.
Setup Configuration
  1. Archie AI here picked a common oversight where variables are conditionally or locally assigned, leading to potential undefined variable errors. AI can help detect such issues more consistently than humans by thoroughly analyzing the code for these subtle errors.
Setup Configuration

Detailed Video Walkthrough

This video covers:

  1. Quick Demo: Setting up and using Archie AI PR Review.
  2. Tips for Optimal Use: Key features and best practices to get the most out of Archie AI PR Review.

Key Takeaways:

  • Easy Setup: Configure GitHub integration through the Archie AI website.
  • Customizable Reviews: Set review preferences for each repository.
  • Actionable Insights: Receive high-quality, concise reviews with actionable suggestions.
  • Time-Saving: Automate repetitive tasks, allowing reviewers to focus on higher-order concerns.
  • Rich Analytics: Track PR metrics and team performance over time.

Pro Tips:

  1. Explore all configuration options, including slash commands for additional functionality.
  2. Utilize features like complete review, incremental review, and interactive Q&A.
  3. Add custom instructions to tailor reviews to your organization's needs.
  4. Monitor analytics to track improvements in your PR process.
  5. Use the chat feature for broader codebase questions and summaries.

Archie AI PR Review aims to streamline your code review process, catch bugs early, and improve overall code quality.

Share This Page

AutofixPR Review (Gitlab)