In the process of collaborative software development, the code review is a key component in ensuring that contributions meet agreed standards of style and quality. In an academic group where understanding of software engineering practices is still in its infancy, the code review has proved to be particularly mysterious, and this has given us the opportunity to develop guidelines and recommendations on how it should be conducted. This walkthrough is informed by our experience guiding software development, taking participants through an example project hosted on GitHub, from the creation of a simple Issue to the merging of a development branch.
The example project is located here:
https://github.com/adcwilliams/code_review