NanoGoogle Code Review

Review another team's project code and test suite before the next class.

Come prepared with a list of issues to discuss with the team who wrote the original code. Each issue listed should include the location in the code (line number or function), the category, the severity, and a short (1-3 sentence) description of the issue. Try to mention at least three good things (category G) about the code as well.

Possible categories for review include:

• D – Design issues
• E – Possible functionality issues
• C – Coding/Style issues
• T – Testing issues
• G – Good point: something that is done well in the code

The severities are:

• 3 – critical issue: if not resolved would compromise the project
• 2 – significant issue: would benefit project or avoid future problems if fixed
• 1 – minor or style issue
• Q – Unsure if this is really a problem

In the review meeting, discuss each issue on each reviewers list. Combine duplicate issues, agree on the category and severity for each issue, and change the issue description if necessary to reflect the consensus of the group. Add any new issues that come up in the discussion of the code to the cumulative list. If there were issues you are unable to discuss during the code review, note those in the cumulative list.

After the meeting, write a general response to all of issues discussed at the meeting, specifically what you learned from them about your project. Then sort the issues in some semantically reasonable way (e.g. by category or section of the code) and, for each issue, briefly respond to it directly (e.g., do you accept that it is an issue or not, or with some revisions).