Archive for February, 2008

Incremental code review (ICR)

Thursday, February 7th, 2008

I suggested that we start doing weekly code reviews on two projects that I’m currently developing on. So we are on week three of one and week one of another. This is a break from the norm where we normally do the code reviews when we are done coding. I’ve been screaming for incremental code reviews for along time.

Some Do’s:

  1. Have the review at least once a week when coding heavy.
  2. Do include the designer or the business expert. (We have caught minor and major items before they became bugs/defects!)
  3. Everyone takes turns showing their code.
  4. Check the egos and the clubs at the door.
  5. Use a separate machine not the developers machine. You  will be surprised at what you find or don’t.
  6. Make sure the machine has access to your CVS or whatever you are using. That way comments and code changes are checked in when you are done with the code review. Never let anyone take a note to change it later.
  7. Ask questions.

Benefits:

  1. Better team and code cohesion.
  2. Catching bugs early in the design.
  3. A true status of where we are.
  4. Pressure to keep the code in synch all the time.

That’s about it for right now. We have caught some holes in the design that would not have been caught until test. I think anyone can apply ICR to whatever methodology the subscribe to e.g. waterfall , agile … etc. We also seem to have a more complete earlier?

I guess I should add that one team has four and the other has three.

Don’t do the review if you don’t have the business people involved.