Home | Clover | Clover.NET | FishEye | Crucible | Support | Account | Download | Buy Now

Review - From Start to Finish

This guide explains in detail how to create a review and manage the review through its lifecycle states until completion.

For an explanation of the different roles, see the Terminology guide

The first step is to create the review. There are two ways to create a review:

Using FishEye it is easy to create a review for a single changeset by clicking on the Crucible icon in the FishEye changelog view. For reviews involving multiple changesets or an arbitary set of files, you can create a review from the Crucible dashboard.

Creating a Review from FishEye

A review can be created by clicking on the small Crucible icon next to the required changeset in FishEye.

Add a Review

By clicking on the icon a new draft review will be created, including the following information:

  • The content of the changeset as the content to be reviewed.
  • The author of the changeset as the Author of the review, if Crucible is aware of this user. Otherwise the creator of the review is the Author.
  • The creator of the review is the Moderator.
  • The commit log message is used as both the Title and Statement of Objectives.

All aspects of the review can be changed. To edit any of the above settings, click on the title or the Manage files tab.

Clicking the Crucible icon, you will see the Review screen, below:

Create Review

The next step is to Add Reviewers. By clicking on the title, you are taken to the Edit details screen.

Creating a review within Crucible

Within Crucible, a review can be created by clicking on the Create New Review link in the top right of every Crucible screen. The Edit details screen looks like this.

Create Review

To select the files to be reviewed use the Manage Files tab and find the files to be added by using the changeset, file or search tab. For more details about the different tabs, read the Manage files tab guide.

Add Reviewers

Before the review can be issued to Reviewers, the Moderator must decide who can review it. This is on the Edit details screen.

Add Reviewers

Next to the author field is the list of Reviewers. If there are less then 7 Reviewers then they are shown with checkboxes next to each name, like the image above. If there are 7 or more Reviewers then it will become a text box. Start typing the reviewer's name and then press tab to select the reviewer. Click Save to continue creating the review, or click Approve (bottom right hand corner).

You can also select an option to allow any user to add themselves as a Reviewer ("Join a review"). This feature is new in Crucible 1.1.2.

Approval

Once the Reviewers have been selected, the next stage is to notify the Reviewers and the Author (if different to the Moderator) that they can start reviewing, the review has been in Draft stage until this point. Only the Moderator has the permission to approve a review.

If you are not the Moderator of your review, then click on "Send to Moderator" which changes the state to "Pending Approval" and notifies the Moderator. The Moderator can change any aspect of the review before approving it.

By approving the review the status of the review is now set as:

Under Review

Reviewing

Active reviews are listed on each Reviewer's dashboard under the default To Review filter. For Authors and Moderators, reviews are listed under Out for Review until all Reviewers indicate they are complete, at which stage they move to the To Summarize list of the Moderator.

TIP: All reviews that involve you in any role are listed under Open or Closed in the My Reviews filters. For instance use the My Reviews | Open filter to locate a review that doesn't require further action from you, but is still underway.

If mailing is enabled by the SMTP settings, the Reviewers will receive an email with information about the review. Click on the link within the email to take the reviewer directly to the Review.

Crucible does not dictate how or what to review. It simply provides a mechanism to record comments. Reviewers might like to read the Statement of Objectives by clicking on the + sign under the title to determine in more detail what the Moderator requires you to review.

Commenting

Comments can be added at the review, revision, or line level.

Adding comments

  • To add a comment that applies to the whole review, click "Add a new general comment" link.
  • To add a comment to a revision/change, expand the specific source by clicking the toggle triangle then click the "Add a revision comment"
  • You can see the source code by expanding the source view. To add a source level comment click on a line of code. You can click and drag to select multiple lines from one revision or diff, or click individual lines to select/deselect them. The comment will appear in the source at the last line selected. Hovering over the comment will highlight the selected lines.
  • To reply to a comment, click the "Reply" button on the right hand top corner of any comment.

TIP: You can save your comments as drafts and then edit later. On Complete you will be prompted to Post/Discard/Edit remaining draft comments.

Draft comments

Defects

Any comment that is not a reply to an existing comment can be flagged as a defect by its author.

Flagging as a defect

You may want to mark comments as defects to associate defect classifications, or simply to highlight to the Author/Moderator that the issue you raised in your comment requires attention. Crucible intentionally does not mandate how defects are to be used. You can customize these defects by the Customize crucible defect classifications screen.

Completing

Once the Reviewer has added comments to the review and has nothing further to add, the next workflow step is to Complete their review.

To complete either press the Complete link on the Dashboard (bottom right):

Complete from the Dashboard

or press the complete button(far right) on the Review screen:

Complete from the Review screen

This flags(via email if configured) to the Moderator that the review has been completed by that Reviewer. Reviewers can still continue to add comments until the Moderator Summarizes the review. The Moderator does not have to wait for all Reviewers to complete before summarizing.

If you have any draft comments, you will be prompted to Post/Discard/Edit any comments before completing the review.

Draft comments

Summarize & Close

As the Moderator, you can choose to Summarize a review at any time. However normally it is recommended to wait for all Reviewers to complete.

The reviews that the Reviewers have completed will be in the menu To Summarize. There are two ways to summarize a review, either by click on the Summarize button (bottom right of the review). See image below:

Summarize menu

Or by previewing the review (see image below) and reviewing the comments and then click on the Summarize button.

Preview Review before Summarizing

TIP: We can see that Stephen Colbert has still not finished reviewing because there is no green tick next to his name

On clicking Summarize, the Moderator may be prompted to confirm if there are incomplete Reviewers or draft comments in the review.

Note
These are warnings only, the review can still be Summarized and Closed regardless.

Once the review is in the Summarize state, the Moderator can optionally add a review summary, i.e. describe the outcomes/tasks/etc.

Summarize screen

The summary is sent to all participants and displayed at the top of the closed review. The Moderator is the only participant who can add comments in Summarize state. This gives the Moderator the responsibility of the "last word".

Reviews in Summarize can be closed. Reviews in Summarize or Closed can be re-opened. Re-opening changes the review's state back to Review allowing all participants to add comments.

Note
Re-opening a review is not the recommended way to "re-review". You should create a new review with the reworked changes and link it to it's parent review for re-reviews.