Working with the code review tool

The Code Review tool is a web-based review tool that integrates with Engineering Workflow Management source control and work items. The tool provides a code review presentation that you can attach to a work item type. The procedure in this topic illustrates a typical code review workflow, which involves an author and reviewers.

Before you begin

You must configure code review for a project area and set any related process preconditions.
Note: The Code Review page does not display content in Microsoft Internet Explorer if the browser is set to compatibility mode. To change the mode, click the Tools icon and select Compatibility View settings.

About this task

To start a code review, one or more change sets must be associated with a work item, at least one change set must be complete, and the target stream must be specified. The typical workflow starts with a developer being assigned a work item and creating changes sets to complete the work item. The recommended workflow for requesting a review uses the Submit for Review action. This workflow applies to the Eclipse client and the Engineering Workflow Management Client for Microsoft Visual Studio IDE.

Procedure

  1. As an author, select the changes sets to review, right-click the selection, and click Submit for Review.
  2. In the Submit changes for review wizard, associate a work item, select approvers, and, optionally, provide a subject for the review.
  3. On the Submit for Review page, you can set the target stream in the Code Review Configuration section. The target stream is used to resolve file path names in code review. If the target stream was set in the work item, such as during a previous review iteration, that stream is listed.
    Note: Although the Submit for Review workflow is recommended, you can also associate your changes sets with a work item, ensure that they are complete, and then use the web client to select the target stream.

Results

After the author submits the change sets for review, the reviewers receive an email notification. If a reviewer raises an issue, the author receives an email notification with a link. The author can click the link to go directly to that issue.
Note: If someone updates an issue, such as adds a comment, changes the status to Must Fix or Resolved, or changes the summary, an email notification is sent to all reviewers, change set authors, approvers, and the creator of the issue. The person who updated the issue does not receive an email notification.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki