Overview of checklists

The RadGrad codebase conforms to a number of conventions and best practices. While these evolve over time, we have discovered that it is very important to both document these conventions and best practices, and review both new and old code to check for compliance. If we don't do this, then the code base quickly accumulates technical debt in the form of brittle and/or difficult to understand code.

This chapter contains a set of checklists that document our current set of conventions and best practices.

The next several pages overview the checklist items with explanations. The final Combined page lists all of the checklist names in one place. That is often easier to use during actual reviews.

Last updated on by Philip Johnson