Configuring code review for a project area

To configure the code review tool for a project area, add the code review presentation as a new tab to the work item types that your team uses to contribute code to your project.

Before you begin

It is recommended from SCM version 7.0 to create a new tab for code review rather than keeping the code review presentation in the work item approvals tab (as in previous versions of SCM). As there is no relationship between work item approvals and code review approvals.

If you have added the code review presentation to the approvals tab, remove it before proceeding with the following steps.

Procedure

  1. On the Application Administration page of the web client, click the Project Areas tab.
  2. On the Active Project Areas page, click the project area that you want to configure.
  3. Click Work Items, then click Editor Presentations.
  4. Select an editor in the Choose the Editor Presentation to edit field.
  5. Under the History section, click Add Tab icon the Add Tab icon.
  6. In the Add Tab window, enter the required fields, for example:
    • Title: Code Review
    • Layout: H Layout
    • Create Tab ID: Code Review
  7. Click OK. A new Code Review tab is added under the Editor Presentations section.Editor Presentation Code Review tab added
  8. Select the code review tab and click Add Section icon Add Section.
  9. In the Add Section window, enter the required fields, for example:
    • Title: Code Review
    • Slot: Left
    • Create Section ID: Code Review
  10. In the Add Section window, under Properties section, click Add.
    1. In the new road added, select noHeader in the key drop-down.
    2. Select true in the value drop-down and click OK. Code Review section is added in the left slot of the Code Review tab.
  11. To add the Code Review Summary presentation to the Code Review section:
    1. Click Add Presentation icon, the Add Presentation icon.
      Note: You are warned that the Code Review tab is shared by other editor presentations. Any changes that you make to this tab are reflected in all work item types that have a code review tab.
    2. Click OK.
    3. In the Add Presentation window, select Non-Attribute-based Presentation.
    4. In the Kind field, select Code Review Summary. Properties section is added automatically.
    5. In the key drop-down, select labelVisible.
    6. In the value drop-down, select false and click OK.
  12. Click Save to save your changes to the project area.
  13. Optional: To reuse the code review tab for other work items:
    1. In the Add Tab window, enter Code Review in the title and select the H Layout.
    2. Select the Reuse Existing Tab radio button and select the Code Review tab you created earlier.
  14. Optional: To define tags and set preferences for code review using the Source Control – Code Review page:
    1. On the Application Administration page of the web client, click the Project Areas tab.
    2. On the Active Project Areas page, click the project area that you want to configure.
    3. Click Source Control, then click Code Review.
    4. Under the Issue Tags section, click the Add icon icon to add a new tag. You can also modify or delete the tags using the Edit Tag and Delete Tag icons under the Actions column.
    5. Under the Preferences section, select the preferences as required to override the default preferences.

Results

Your project is configured for code review. The code review presentation is added to the code review tab. The Overview tab displays the summary of the code review in progress, the author, code review status and review cycle, target stream, and reviewers. It also presents a list of files in the change sets, along with links to currently open must-fix issues and extracted work items. You can select a target stream and add reviewers. The Review tab displays the comparison of the code with the previous version. You can raise new issues and filter the results based on the issues.

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