Skip to content

Latest commit

 

History

History
31 lines (15 loc) · 1 KB

File metadata and controls

31 lines (15 loc) · 1 KB

Code review resources

Personal comments:

  • Most importantly, code review is not a paper review. Its primary goal, almost always, is to make the code a better fit, better for future maintenance and useability.

  • There is no one size fits all rules for code review.

  • Projects may have different checklicks and review guides. Follow them when they exist.

  • Generally, be nice. You may know the person who contributes, but there are others who may just read your interactions and don't know personal contexts.

Slides

Madicken Munk put together these good practices; consider following them:

https://munkm.github.io/research-software-schools/peer-review.slides.html#/

TL;DR -- Code reviewing is not trivial, be nice during the process.

Code review tutorial

Helen Kershaw (NCAR) has put together this Code Review Tutorial exercise. There are both Python and Fortran versions.

https://code-review.org/