Source Code Review

What is it and why do it?  

For teams that do system development activities that include writing source code, establishing a a code review policy and process is a best practice to help ensure a quality system. A code review is a process by which developers have their source code reviewed by another developer in order to discover bugs, scrutinize coding conventions, and look for potential bottlenecks and resource leakage. The intent of a code review is to catch bugs/issues/defects before the offending code is deployed to a production environment and to transfer knowledge of implementation details to the rest of the team.  In addition, code reviews may be used to ensure code is well documented and meets any coding conventions that have been established.  For an example of what to look for see this code review check list.  

"The purpose of a code review is for someone other than the programmer to critically go through the code of a module to ensure that it meets the functional and design specifications, is well-written and robust. An incidental benefit is that the reviewer may learn some new programming techniques, and more people in the team become familiar with the module. The reviewer should not try to fix any bugs or improve the code. S/he should merely inform the programmer about potential bugs and possible improvements. The responsibility for actually making the changes and testing them lies with the programmer. " file:///Users/jeshiver/Downloads/Code-Review-Principles-Process-and-Tools.pdf

Examples and References 

In this example, the team uses Git Hub tickets to help manage the code review process.  https://wiki.openmrs.org/plugins/servlet/mobile#content/view/2818253

file:///Users/jeshiver/Downloads/Code-Review-Principles-Process-and-Tools.pdf