FredHutch
Put an overview of Code Review guidance in
We need a concise summary of the importance of code review and refer to this content: https://hutchdatascience.org/code_review/ and the content in the WILDS about code review.
Move this content over to this page too: https://sciwiki.fredhutch.org/scicomputing/software_examples/
During the DHCs & Docs meeting on July 2 @sitapriyamoorthi informed me that the scope of this page is meant to be guidance for labs reviewing software, analysis code, and computational workflows. I think this project is beyond the scope of one wiki page, so we would like to discuss it during the DSS review meeting. There is lots of existing guidance when it comes to code review. Here are some relevant links, though there are many more:
- https://hutchdatascience.org/code_review/index.html
- https://getwilds.org/guide/codereview.html
- https://discuss.ropensci.org/t/how-do-you-review-code-that-accompanies-a-research-project-or-paper-help-ropensci-plan-a-community-call/1321/30
- https://pmc.ncbi.nlm.nih.gov/articles/PMC11376551/
- https://www.carolinemorton.co.uk/blog/code-review-for-research-code/
- https://uwescience.github.io/neuroinformatics/2017/10/08/code-review.html
- https://arxiv.org/abs/1407.5648
- https://smartbear.com/learn/code-review/best-practices-for-peer-code-review/
- https://www.nature.com/articles/s43588-022-00261-w
Thanks Sean for tagging this here: I think in terms of scope we talked about how the SciWiki article could be the "home base" for code review and we could link out to very specific examples or like the links you have posted above where relevant.
But I think this is a great idea to discuss in the DSS meeting or other relevant spaces.
