Project

General

Profile

Code Review Guide » History » Version 4

Amber Herold, 03/04/2010 04:47 PM

1 1 Amber Herold
h1. Code Review Guide
2
3
[[Purpose of Code Reviews|What's the point of code reviews]]?
4 2 Amber Herold
5 4 Amber Herold
[[Code development process|Where do code reviews fit into the code development process]]?
6
7 2 Amber Herold
h2. The Process
8
9
# Developer writes code
10
# Developer checks code into Subversion
11
# Developer updates Redmine issue with:
12
## the svn revision number 
13
## a description of the changes 
14
## a reference to test cases or a description of how to test the changes
15
## set the Status to In Code Review
16
## assign the issue to another person to perform a code review
17
# Code reviewer receives an email that they have code to review
18
# Code reviewer inspects the changes to the code using the review guide. 
19
## Revisions that involve complicated logic or widespread changes are better done in person. In this case the reviewer can ask the developer to do a walk through.
20
# If the reviewer finds a problem, the Redmine issue is updated with:
21
## a description of the problem
22
## the Assigned to field is set back to the developer and the process starts over.
23 3 Amber Herold
# If no problems are found, the Redmine issue is updated with:
24 2 Amber Herold
## The Status is set to In Test
25 1 Amber Herold
## The Assigned to field is set to someone who can readily test it.
26 3 Amber Herold
# The fly server is updated nightly with the latest code in SVN. The code may be tested at http://fly/myamiweb the day after the code is checked in. 
27
# If the tester finds a problem, the Issue is reassigned to the developer and the process starts over.
28
# If the tester does not find a problem the Issue Status is set to Closed.