Users Guide¶

Review Board is an open source tool used to help with the peer review process for source code, documentation, images, and more. It’s web-based, extensible, and built to work with a wide variety of environments and source code management systems using pre-commit review and post-commit review methods.

Getting Started with Code Review¶

New to code review? Start here to learn some of the basics before you get going with Review Board.

The Dashboard: Your Code Review Inbox¶

The first thing you’ll generally see when you log in is the Dashboard. This tracks all the review requests you’ve posted and all the ones sent your way for review. It’s customizable, letting you show and filter things just the way you want.

Learn about the Dashboard

Managing Your Account¶

Once you get going with Review Board, you’ll want to take a look at your account settings. Here you’ll be able to update your profile information (such as your name and e-mail address), join review groups, customize your settings, manage API tokens, and more.

Manage your account settings

Creating and Managing Review Requests¶

A review request is a proposed change, a collection of code, documents, or other content, which is published for review. They can be modified in a draft state and then published for others to see.

Review requests are central to Review Board, and you’ll want to learn how to work with them. We recommend starting with the overview.

Getting started¶

Making changes¶

Finishing up your changes¶

Reviewing Code and Documents¶

Review requests can store all kinds of content, from code to documents to images to arbitrary files. In this section, we’ll tell you how to review that content.

Basic concepts¶

Reviewing content¶

Managing reviews¶

Discussing reviews¶

Replying to comments

Editing in Markdown¶

When composing review requests, reviews, or replying to comments, you have the option of using Markdown. Spice up your text with text formatting, code samples, images, and more.

Using Markdown

Searching for Review Requests and Users¶

Depending on your server’s search settings, you may be able to look up review requests and users through a handy search field at the top of any page.

If full support for search is enabled, you’ll be able to take advantage of full-text search. If not, you’ll still be able to use what we call Quick Search, a more limited but still useful way of quickly locating and jumping to a review request or user.