Code Review During Research 0.1.0 documentation

  • Code Review Workflow
    • Find a reviewer
    • Meet and agree on objectives
    • Perform code review
  • References and related work
  • Glossary
Theme by the Executable Book Project
  • .md
Contents
  • References
    • Guidelines
    • Research articles
  • Related work
    • Guides and checklists
    • Blog posts
    • Podcasts

References and related work

Contents

  • References
    • Guidelines
    • Research articles
  • Related work
    • Guides and checklists
    • Blog posts
    • Podcasts

References and related work#

References#

Guidelines#

Guidelines were adapted from the following sources:

  • Oxford Code Review Network guidelines for reviewers: https://github.com/OxfordCodeReviewNet/forum/blob/master/guidelines_for_reviewers.md

  • Introduction to Contemporary Peer Review Practices in Research Software given by Jeff Carver at the 2019 URSSI Winter school.

Research articles#

  • Petre, Marian, and Greg Wilson. “Code review for and by scientists.” arXiv preprint arXiv:1407.5648 (2014). https://arxiv.org/abs/1407.5648

  • MacLeod, Laura, et al. “Code reviewing in the trenches: Challenges and best practices.” IEEE Software 35.4 (2017): 34-42. https://ieeexplore.ieee.org/abstract/document/7950877/

Related work#

  • https://codecheck.org.uk/ provides workflow, guidelines and tools for code review as part of peer review for publication.

Guides and checklists#

  • Checklists from the Turing Way Guide to Reproducible Research chapter on code review:
    https://the-turing-way.netlify.app/reproducible-research/reviewing/reviewing-checklist.html

Blog posts#

  • “Code reviews: the lab meeting for code”, Fernando Perez http://fperez.org/py4science/code_reviews.html

  • “Research Code Review: Best practices, Challenges and Opportunities”, Emmy Tsang https://osc-delft.github.io/posts/2021/09/03/Research-Code-Review/

Podcasts#

  • Michaela Greiler on Code Reviews https://www.se-radio.net/2020/02/episode-400-michaela-greiler-on-code-reviews/

previous

Perform code review

next

Glossary

By Research Code Review Community
© Copyright 2022, Research Code Review Community.