Review Map Tours Quick Start

Code Reviews are a lot for anyone to manage let alone if you are reviewing 20 files or more. Review Map Tours let you put your thoughts together with just a few clicks. The author of the change can guide the reviewer around — giving them key information and saving up to 30% of the reviewers time. Or the reviewer can put their thoughts together themselves.

Here are 3 types of Tours you can create.

1. TL;DR - Start here

Code hosts like Github display the files changed alphabetically. So when the author provides a tour point on a Review Map indicating to the reviewer "Start Here", it will shave off the time it take for the reviewer to get oriented.

2. Walk through

A good walk through can be as comprehensive as the PR author needs it to be in order to guide the reviewer. Good PR Tours at a minimum should articulate:

• What changes you made
• In what order to review the changes
• Why you made the changes you did

Gotchas

Sometimes there's a particularly tricky part of a code change. The reason we made that code change might not be 100% obvious. Creating a tour point to explain a gotcha is a quick way to help someone wrap their head around the review and get your change merged. No meeting required!