Saif ChaudhryPrincipal Software Engineer, Red Hat

← All projects

In progress

Guided Review

A guided, visual tour of a pull request.

A Guided Review step for a pull request: a plain explanation on the left, a flow diagram of the change and the diff on the right.

About

Guided Review turns a GitHub pull request into a short tour. An overview says what changed and what to look at closely. A guide walks through the change one plain step at a time, with a small diagram where it helps, and a clean diff view sits underneath. It runs as a small web server on your own machine, so nothing is hosted.

Status:
In progress, early
Runs:
Locally, on your own machine
Works with:
GitHub pull requests

Screens

The Guided Review Overview tab: a summary of what changed, what to check carefully, the list of steps and a diagram of the changed parts.
Overview: what changed, what to check, and the steps
The Guided Review Diff tab: a list of the five changed files above the diff of readme.md.
The Diff tab: every file at a glance
A Guided Review step: what changed and why it matters on the left, the matching diff on the right.
A step with its diff