Add a step to review the overall context of the code

ResearchCodeReviewCommunity / dev-review

website with resources for researchers learning about code review during development

https://dev-review.readthedocs.io/en/latest/

5 stars 3 forks source link

Closed bielsnohr closed 2 years ago

bielsnohr commented 2 years ago

During our meeting about outlining the actual code review cycle (notes here, it was agreed that the overall structure and context of the code should be explained at the "Meet and Agree on Objectives" step. Looking at our current recipe for that step, explicit mention of the author introducing the code, its purpose, and structure is missing: https://github.com/ResearchCodeReviewCommunity/dev-review/blob/main/site/content/recipes/meet_and_agree_on_objectives.md

bielsnohr commented 2 years ago

There should also be a step of sorting out some practicalities, like when the code segment to be reviewed needs to be shared.

NickleDave commented 2 years ago

I think this was fixed by #65 even though as discussion there states the "explain code structure" might not be completely integrated

I'm going to close this issue since I think it duplicates others (#61)