© 2012 IBM Corporation Rational Insight | Back to Basis Series Chao Zhang Code Review

© 2012 IBM Corporation Rational Insight | Back to Basis Series 2 06/19/12 Agenda Overview Purpose Process – Roles & Responsibility – Review flow – Online Review – Offline Review Example in RTC

© 2012 IBM Corporation Rational Insight | Back to Basis Series 3 06/19/12 Overview Code review provide a strict method of examining work products for early detection and elimination of errors. By error, it is meant product defect as potentially left for the next phases of the Life Cycle Model but also any design issues or imprecision that can lead to a product quality issue. Source code review has been shown to be a most effective measure for reducing cost and time to market during the software development process

© 2012 IBM Corporation Rational Insight | Back to Basis Series 4 06/19/12 Purpose Verify that work products satisfy design requirements and assess the correctness of the algorithms. Remove structural and low-level semantic coding errors, coding standards violations, and architectural violations from work products.

© 2012 IBM Corporation Rational Insight | Back to Basis Series 5 06/19/12 Process Roles & Responsibilities Author – The author is the designer who produced the work product to be inspected. Moderator – The moderator facilitates the meeting, ensures that inspectors are prepared and that the right expertise is present. Recorder – The recorder ensures all defects have been captured in review tools, updates the inspection record, and records the meeting disposition. Reviewer – The reviewer are design team members who inspect the code to find defects and record the defects found in review tools. Design Manager – is the manager or prime who is responsible for the quality of the code being reviewed.

© 2012 IBM Corporation Rational Insight | Back to Basis Series 6 06/19/12 Process Review Flow Planning & Overview Code Review Defects found ? Code review again? ReworkVerification Enter Exit Yes No Yes No

© 2012 IBM Corporation Rational Insight | Back to Basis Series 7 06/19/12 Process Online Review Author prepare code review, e.g: codes, review tools, attendee list. Author send the review invitation to attendees. Reviewer prepare code review before meeting, e.g: read codes first, prepare related knowledge. In review meeting: – Author introduces the reviewed codes – Reviewer provides comments – Recorder record comments Author correct codes against the review comments. And then: – Launch a new round review meeting if need. – Send codes to attendees to ask for offline review.

© 2012 IBM Corporation Rational Insight | Back to Basis Series 8 06/19/12 Process Offline Review Author prepare code review, e.g: codes, review tools, reviewer list. Author send the review notification to reviewers. Reviewer should review codes and fill comments in review tools. Author should reminder silent reviewer and check with them if they finish reviewing without any comments Author correct codes against the review comments and send a new review notification to reviewers.

© 2012 IBM Corporation Rational Insight | Back to Basis Series 9 06/19/12 Example in RTC Prepare codes, check in your public workspace and associate the changes set with work item. In 'Approvals' of work item, add the reviewer and approvals. RTC will automatically send a notification mail to them. Reviewer should review the codes and write the comments in work item or change the state to 'Approved' if no comment. Author need check comments and correct codes if need. When all reviewers approve the codes, the approval can change the state to 'Approved'. Author can deliver the codes to stream after get all approvals.

© 2012 IBM Corporation Rational Insight | Back to Basis Series 10 06/19/12

© 2012 IBM Corporation Rational Insight | Back to Basis Series 11 06/19/12 Revision History AuthorDateVersionComment Chao Zhang Initial Draft