Reviews and Comments¶
A review is a collection of comments and your indication of approval for a review request. All comments that you make are grouped under a single draft review, which only you can see.
When you’ve finished your review, this draft can be published, allowing the owner of a review request and any other reviewers to see it and discuss it.
Reviews consist of:
A Ship It! indicator, if approving a review request.
A header, providing a summary of the review.
A list of comments made on diffs, file attachments, or the review request as a whole.
A footer, providing a conclusion to the review.
These are all optional, and depend on the feedback you’re giving. Most of your feedback will be in the form of comments, which allow for tracking issues that need to be fixed.
Reviews are created automatically when filing comments, or when clicking Review in the review request action bar. They’re private and can be edited until published using the review banner or the review dialog.
Let’s take a look at the parts of a review:
1. Ship It!¶
Reviews approving a change are represented with a Ship It! label. This means that the person reviewing the change is happy with how things look and are indicating their approval.
Changes can also be in a Fix it, then Ship it! state, which means that they’re happy once a couple of specific things are fixed. This is set automatically when a review both opens issues and has a Ship It!
2. Review Headers¶
A header is a block of free-form text displayed before any comments. It’s often used to provide a summary of your review, or to leave encouraging feedback. Unlike comments, there is only one header allowed per review, and they don’t support tracking issues that need to be fixed.
The header should not be used to review content. Instead, you’ll want to file comments instead.