Code Reviews

published on 10 August 2013

Code reviews are an in important step in a mature SDLC (Software Development Lifecycle).  At multiple points within our Methodology we employ the use of code reviews.

Formal Code Review Process

  1. Discuss project scope with Manager and Developer.
  2. Review the clients Coding Standards.  If they don’t exist, we are happy to develop them.
  3. Review the clients Code Review Procedures.  Again, If they don’t exist, we will develop them.
  4. Review the work items included in the release or Sprint depending on the development methodology that the client is using.
  5. Review the changes, tags or labels in the version control system.  If a version control system is not being used with tags, then we will take snapshots from various sources and build the change list (delta scope).
  6. Review all change descriptions and correlate to a work item.
  7. Classify changes by deployment / usage.
  8. Review all source code changes.
  9. Review QA Test results (if requested and provided).
  10. Review Load Test results (if requested and provided).
  11. Review Security Test results (if requested and provided).
  12. Generate report..

Code Review Report

The code review report may contain the following.

  • Cover Page
  • Document Revision History
  • Terms
  • Objective
  • Team Definition and Member Responsibilities
  • Approach
  • Systems Impact
  • Reference Materials
  • Code Review Checklist
  • Version Summary
  • Work Item Summary and Detail
  • Chronology
  • Third Party Developer Tools List
  • Source Code Type Summary
  • Source Code Review
  • Observations and Findings
  • Major and Minor Concerns
  • QA Test References
  • Stress Test References
  • Security Test References
  • Conclusion

Read more