Creating code review coverage reports

Code review coverage reports include information about file versions in code reviews and if the file reviews are complete or still in progress. Use these reports to determine if you are ready to release your product, measure coverage of your code review process, or demonstrate quality control during an audit.

Code review information is displayed in the following columns, which are included in the report by default.

Column Contains:
Reviewed Versions Version numbers of a file that are in a code review with an Approved status. A code review is approved only if all individual file reviews in it are complete.
Unreviewed Versions Version numbers of a file that are not in an Approved review.
Code Reviews List of code reviews a file is included in and the version numbers, sorted oldest to newest. If a version is in a review that is not Approved, the review status is also indicated. For example, 'CodeReviewA (1, 3-5) - Needs Attention ' indicates that versions 1, 3, 4, and 5 of the file are included in the CodeReviewA review, which has a Needs Attention status.
When working with code reviews, you can also run reports that provide historical information about a review and the files in it. Use these reports to review unaddressed comments, review your code review process, or save process information for audits. See Running code review reports.

1. Choose Tools > Reports.

The Reports dialog box opens.

2. Click Add.

The Select Report Type dialog box opens.

3. Select Code Review Coverage and click OK.

The Add Report dialog box opens.

4. Enter a Report name.

5. Select a Public/private report option.

Public reports are shared with all users. Private reports are not shared. You may only be able to create private reports depending on your security permissions.

6. On the Restrictions tab, select the criteria that files must meet to be included in the report.

The Report Restriction dialog box opens. The options change based on the selected restriction.

7. Enter or select the restriction values. See Adding restrictions.

8. Click OK.

The restriction is added. The values are displayed in the restriction list and the Summary field.

To change a value, double-click it in the Restrictions list.

9. Add any additional restrictions.

10. Click the Output tab.

11. Select an Output format.

Reports can be formatted in HTML, space-delimited columns, or tab-delimited columns.

12. Select a report Stylesheet.

Cascading Style Sheets (CSS) are installed with Surround SCM to create reports with a predefined layout and design. You can customize these stylesheets or create your own. Stylesheets for code review coverage reports are stored in the StyleSheets\CodeReviewCoverage directory in the Surround SCM application directory on the server.

13. Select the sorting and order options.

  • Primary sort column and Order sorts the first column of report results.
  • Secondary sort column and Order sorts the second column of report results (optional).

14. Select Only include information for current file version to only include information about the current versions of files.

If this option is selected, Surround SCM checks if the current version of a file, which is the version displayed in the source files list, is included in the code review. If this version is in the review and meets the restriction criteria, information about the file is included in the report. If the current version is not in the review, no information about the file is included in the report. If this option is not selected, information about all versions of files in the review that meet the restriction criteria is included.

15. Select Do not include files with all versions in approved reviews to exclude files that meet the restriction criteria and have all versions in code reviews with an Approved status.

If Only include information for current file version is also selected, files with the current version in an Approved review are excluded. Selecting this option is helpful to show unreviewed files and help you determine files that need review before you release your product.

16. Select the Field Options to specify the columns to include in the report.

Select the column to add in the Available columns list and click the right arrow button to move it to the Selected columns list. To remove a column, select it in the Selected columns list and click the left arrow button. Select a column in the Selected columns list and click Top, Move Up, Move Down, or Bottom to change the display order.

17. Click OK.

The report is added. See Running reports for information about running reports.