Code checklists

brian_d_foy on 2002-11-23T22:20:50

Randal and I talked about code checklists as we did a code review last week. As an example, I offer my code checklist. I keep my in an Excel workbook---if that does not work for you, I also have PDF snapshot. Periodically I print this out and keep it with my other development stuff in a binder. As I fix things, I check off the items I fixed. Eventually I update the workbook and print out a fresh copy.

Everyone's checklist is different. Some of it depends on local style and what needs to be fixed. A lot of my checklist has to do with tests and documentation.

As people report problems in one module, I might recognize it as an overall problem in the way I do things, so I add it to the checklist.

This is only the first version of this notion though. If I was high speed, I would have most of this automated and graphed. All I need is the code to check this and a source tree to run it against.

I'll have to add automation to my checklist. :)