+
Skip to content

wandb/co-reviewer

Repository files navigation

Co-Reviewer

Co-reviewer is a tool that helps code owners review changes in pull requests efficiently. It provides a clear view of which changes need review and which have already been approved.

image image

Features

  • View changed files in a pull request with side-by-side diff view
  • Filter files by code owner
  • Filter files by review status (reviewed/unreviewed)
  • See code ownership information for each file
  • Track review status across files

Prerequisites

  • Node.js 16.x or later
  • pnpm
  • A GitHub personal access token with repo scope

Setup

  1. Clone the repository and navigate to the co-reviewer directory:
cd core/tools/co-reviewer
  1. Install dependencies:
pnpm install
  1. Create a .env file based on .env.example:
cp .env.example .env
  1. Edit the .env file with your GitHub configuration:
GITHUB_TOKEN=your_github_token_here
GITHUB_OWNER=your_org_or_username
GITHUB_REPO=your_repository_name
GITHUB_PR_NUMBER=your_pr_number

Development

To start the development server:

pnpm run dev

The application will be available at http://localhost:3000.

How It Works

  1. The tool uses the GitHub API to fetch:

    • Changed files in the PR
    • Code owners for each file
    • Review status for each file
  2. It aggregates this information to show:

    • Which files need review from which code owners
    • Current review status of each file
    • Diff view of the changes
  3. Code owners can filter the view to:

    • See only files they need to review
    • Focus on unreviewed changes
    • Track their review progress

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载