Homework 8: Executive Summary; Code Review

Due date: Thursday, April 10

1) Each team submits an executive summary of their project. The summary will be used for departmental publicity and for advertising the public demos on April 22. It consists of one paragraph, is written in the third person, and must mention the name of the project and the names of the team members. It describes the purpose of the project and the basic technology used and mentions the name of the client partner.

2) On Thursday, we will be doing code reviews. Each team picks a part of the source code of the project they are assigned to review, and performs a code review for it. Each person reviews at least one non-trivial class. Each person turns in a report of their code review (both to the TA and to the development team, ideally through the course wiki). This report contains the following information:

discussion of coding style,
discussion if there are sufficient and appropriate comments and suggestions for improvement,
discussion of appropriate use of assertions, and suggestions for improvement,
discussion of proper use of defensive programming and error and exception handling,
discussion whether the unit tests are sufficient,
discussion of the class design, and suggestions for improvement.

Any potential bugs or issues must be noted; if the reviewer is sure that a certain item constitutes a bug it should be submitted to the bug tracking system. The code review report will be presented during class; the reviewers will be asked to project the code they are discussing on the big screen.

CS 498 Spring 2008