ai-codereviewer

AI Code Reviewer: A Smart Tool for Developers

AI Code Reviewer is an innovative GitHub Action designed to streamline the code review process by utilizing OpenAI's cutting-edge GPT-4 API. This tool is a game-changer for developers, offering an efficient and intelligent way to enhance code quality while significantly reducing the time spent on manual reviews.

Features

The AI Code Reviewer is packed with features that make code reviewing an effortless task:

• Automated Code Reviews: It reviews pull requests using the advanced capabilities of the GPT-4 API.
• Intelligent Feedback: Provides insightful comments and suggestions aimed at improving the overall code quality.
• Exclusion of Unneeded Files: Developers can specify exclude patterns to filter out files that do not require review.
• Easy Integration: Setting up and incorporating this tool into a GitHub workflow is straightforward.

Setup Guide

To begin using the AI Code Reviewer, follow these simple steps:

1. Obtain an OpenAI API Key: First, ensure you have an API key from OpenAI. If not, you can register for a new key at the OpenAI website.

2. Secure the API Key: Add your OpenAI API key as a GitHub Secret named OPENAI_API_KEY in your repository settings. Guidance on setting up GitHub Secrets is available here.

3. Configure the GitHub Action: Create a file named .github/workflows/main.yml in your repository with the following YAML configuration:

name: AI Code Reviewer

on:
  pull_request:
    types:
      - opened
      - synchronize
permissions: write-all
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v3

      - name: AI Code Reviewer
        uses: your-username/ai-code-reviewer@main
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL: "gpt-4"
          exclude: "**/*.json, **/*.md"

4. Adjust for Personal Use: Replace your-username with your GitHub username or organization name where your AI Code Reviewer repository resides.

5. Tailor File Exclusions: Customize the exclude parameter to specify additional file types or patterns that should be ignored.

6. Commit Your Configuration: Once the setup is complete, commit these changes. The AI Code Reviewer will now automatically engage with new pull requests.

Operational Process

Upon activation, the AI Code Reviewer action pulls in the differences from the submitted pull request, removes any files matching the exclusion criteria, and sends snippets of the code to the OpenAI API. The AI interprets the code and crafts informative review comments, which are then posted directly to the pull request.

Contributions and Development

The project encourages contributions from the community. Whether suggesting improvements or submitting pull requests, community involvement is welcome. Contributors should let the system maintainers handle the final package generation using yarn build and yarn package.

Legal Information

AI Code Reviewer is available under the MIT License. For further details, refer to the LICENSE file in the project repository.

In summary, AI Code Reviewer provides an advanced and efficient way to elevate the code review experience, all while saving developers valuable time. It's a tool that aligns perfectly with modern software development practices.