Submitting your changes for code review

As an author to begin code review, you must first submit your changes for review. To submit completed change sets for review, associate it with a work item and add team members as reviewers. The following procedure explains how to initiate code review by using the Engineering Workflow Management (EWM) client for Microsoft Visual Studio.

Before you begin

Ensure that your project area is configured with code review before you submit your changes. If not configured, contact your project area administrator to configure your project area for code review.
Note: In older clients (before 7.0), you can still use the Submit for review action. In addition to approvals being added to code review they are also added to the work item. However, the work item approvals is no longer required and can be removed.

About this task

The typical workflow starts, when a work item is assigned to an author. The author then creates change sets to complete the work item and initiates the code review by using the Submit for Review action.

Procedure

  1. As an author, in the Pending Changes view, select the changes sets for review, right-click the selection, and click Submit for Review.
  2. If a work item is not associated with the change set, the Submit Change Sets for Review wizard prompts you to do so.
    For more information, see Associating work items with change sets.
  3. In the Submit for Review wizard:
    1. To suspend the change sets while you await responses from reviewers, select Suspend change sets.
    2. Optional: By default, the target is set as your workspace stream. You can change the target stream if required.
    3. In the Reviewers section, click Add to add reviewers.
      In the Enter user name field, enter a text string and click Search to search for the name of a reviewer. Click to select one or more (use Ctrl key) reviewers in the Matching users field, click Select and then click OK.
    4. Optional: Enter a brief submit comment.
      This comment is included in the email notification and displayed in the Overview tab of the code review page.
  4. Click Finish.
    You can view the code review summary, open the code review page, and resubmit for review from the code review tab, in the work item view of the EWM client for Microsoft Visual Studio. The code review presentation is displayed according to the configuration settings done by your project area administrator. It is usually added to the Code Review tab for ease of access and usability.

Results

The author is not allowed to add or remove change sets while code review status is 'In Review'. The reviewers receive an email notification with the link to access the code review page and the work item details.

What to do next

The next steps involve the actual process of conducting a code review that takes place in the web client.