• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. Review Board 1.5
    2. Version 7.x
    3. Version 6.x
    4. Version 5.0
    5. Version 4.0
    6. Version 3.0
    7. Version 2.5
    8. Version 2.0
    9. Version 1.7
    10. Version 1.6
    11. Version 1.5
    12. Version 1.0
    13. Users Guide
    14. Managing Review Requests
    15. Creating Review Requests
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • General Workflow
  • Navigating Review Board
  • Dashboard
  • Searching
  • Managing Review Requests
  • Creating Review Requests
  • Updating Review Requests
  • Closing Review Requests
  • Reviewing Review Requests
  • Reviewing Diffs
  • Reviewing Screenshots
  • Editing and Publishing Reviews
  • Replying to Comments
  • Tools
  • post-review
  • Administration Guide
  • Installation
  • Installing on Linux
  • Installing on Windows
  • Upgrading Review Board
  • Installing Development Releases
  • Site Maintenance
  • The rb-site Tool
  • Creating Sites
  • Upgrading Sites
  • Enabling Search
  • Management Commands
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Settings
  • General Settings
  • Authentication Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • File Storage Settings
  • Management
  • Managing Default Reviewers
  • Managing Permission Groups
  • Managing Repositories
  • Managing Review Groups
  • Managing Users
  • Web API Guide
  • Overview
  • Authenticating
  • Resource Tree
  • Resources
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • File Diff Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Repository Resource
  • Repository Info Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review Draft Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Root List Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • Screenshot Comment List Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • Glossary
  • Overview
  • Authenticating
  • Web API Reference
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Data Types
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • API Calls
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • REST API 2.0
  • Overview
  • Authenticating
  • Resources
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • File Diff Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Repository Resource
  • Repository Info Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review Draft Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Root List Resource
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Screenshot Comment List Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • Glossary
  • REST API 1.0 (deprecated)
  • Overview
  • Authenticating
  • Web API Reference
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Data Types
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • API Calls
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Frequently Asked Questions
  • General Index
  • Release Notes
  • This documentation covers Review Board 1.5. You can select a version above or view the latest documentation.

    Creating Review Requests¶

    A review request consists of, at a minimum, a summary, a description, and some reviewers. A review request usually has a diff, but it isn’t required, as the review request may be used for screenshot review purposes only.

    There are two main ways of submitting a new review request: through the web UI and through post-review. We recommend the latter when posting diffs for review, as it does a lot of work for you, and is actually required for some version control systems, such as Perforce.

    Web UI¶

    To post a review request through the web UI, click New Review Request in the upper-left of a page. This will take you to a form where you can create your review request. What information you provide depends on whether you’re posting a diff for review, or intending to post screenshots for review.

    Once you’ve filled out all fields, click Submit to post the review request.

    Review Requests for Diffs¶

    If you’re uploading a diff, you will need to select a repository and browse to the diff you wish to upload.

    The diff you provide needs to be in unified diff format, and must have revision information embedded in the file. CVS, Subversion, Git, Mercurial and Bazaar provide this information. If you use Perforce, though, you’ll need to use post-review instead of the web UI. Note that this means you can’t just use a standard diff generated by the diff tool. You’ll need to consult your version control system’s documentation for information on generating diffs.

    Once you’ve generated the diff, specify it in the form. You’ll also need to specify the repository containing the code that the diff was generated against. On many Review Board installations, you’ll only have one choice, but some may have multiple ones to choose from.

    ../../../_images/new-review-request-form.png

    After selecting the repository, additional fields dependent on that repository may become available. Here are some fields you may encounter.

    Perforce repositories:

    • Change Number:

      The changeset number representing the change the diff is generated from.

    Subversion repositories:

    • Base Directory:

      The relative path of the directory you were in when you generated the diff, based on the repository. For example, if you locally have a checkout of trunk/reviewboard named reviewboard, and that was the directory you were in when you made the diff, then the base diff path would be /trunk/reviewboard.

      This may also depend on how Review Board was configured. Consult your administrator if you have problems.

    Review Requests for Screenshots Only¶

    If you’re intending to post a review request only for screenshot review, you will want to change the Repository to (None - Graphics only). You will not be able to add any diffs to this review request, but after creating it, you will be able to add screenshots.

    No other fields will need to be provided when using this option.

    Finishing the Review Request¶

    Once you’ve posted your initial diff through the web UI or post-review, you’ll have a draft of your review request posted. Nobody but you will be able to see the review request until you publish it.

    Before you publish the review request, you’ll need to fill out the summary, description and reviewers. Some of these fields may be filled in depending on your repository type, the tool you used to post the review request, and any defaults your administrator has set up for the reviewers (see Managing Default Reviewers if you’re the administrator).

    You can also add screenshots or preview your diff by clicking View Diff in the review request action bar (in the top-right of the review request), or replace it if the diff wasn’t correct.

    When you’re finished, click Publish Review Request in the green draft banner above the review request. You can also choose to discard the review request by clicking Discard.

    Depending on your particular setup, publishing a review request may send an e-mail out to the reviewers, letting them know your change is ready to review.

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • Web UI
      • Review Requests for Diffs
      • Review Requests for Screenshots Only
    • Finishing the Review Request