Copyright © 2008 by the Commonwealth of Pennsylvania. All Rights Reserved.

Code Review RecordPage 1 of 6

Table of Contents

1.Introduction

2.Code Review Process

3.Code Review Worksheet

Document History

Version / Date / Author / Status / Notes
1.0 / 02/06/2008 / Frank Froment / Final / Adapted From PA-NEDSS

1.Introduction

The Code Review process and worksheet provide a series of prescribed steps that must be taken by developers in order to have their code formally reviewed and approved for deployment to the any of the various PADOH/BIT systems. The below steps and required documents will ensure a high quality product and reduce overall defects within the target systems.

2.Code Review Process

  1. Code submitter fills out the Code Review worksheet found in Section 3 and stores the electronic version with the appropriate project folder. Completed documents and/or their locations are sent to the reviewer(s). Date Submitted is marked. Give three days lead-time between the time you submit your documents for review and the Code Review meeting. Provide the following information, as required, for code review:
  • Source code location in Visual Source Safe
  • Technical design document(s)
  • Test script (if required)
  • Implementation guide (if required)
  • Code review checklist(s)
  1. Code reviewer(s) review the code. Reviewer(s) capture comments during the formal code review.
  2. Comments will be discussed during the Code Review meeting. (1.5 hours allocated for discussion)
  3. Code submitter makes the necessary corrections, tests changes, checks code back into VSS and informs the Development Lead. (Date 2nd Version Submitted is marked).
  4. Unless there are major changes or concerns a second formal meeting is not required. The Development Lead reviews the code to verify that the corrections identified were made. If the changes are acceptable, the “Date 2nd version reviewed” is marked. The Development Lead signs off on the changes and saves the completed document in the specific project folder. (30 minutes allocated for follow up review). If the changes are not acceptable the code submitter makes further changes and resubmits to the Development Lead for review.

Figure 1: Code Review Process

3.Code Review Worksheet

Code Submitted By: / <Developer Name> / Date Submitted: / <Date items sent to reviewers>
Code Reviewer(s): / <Reviewer Names> / Date Reviewed: / <Code review date>
Date 2nd Version Submitted: / <Resubmit date> / Date 2nd Version Reviewed: / <2nd Review Date>
Final Sign Off: / <Development Team Lead Name>

Attach additional sheet if necessary

Page/Object/Procedure/Function Name / Level of Changes (Brand New, Minor Changes, Medium Level of Change, High Level of Change)

Version 1.0 – 6 February 2008