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

Improvements and fixes for the 'Meet and Agree on Objectives' Step #61

Open bielsnohr opened 2 years ago

bielsnohr commented 2 years ago

Revisiting this section in preparation for the workshop, I have noticed a few items that need attention. We can split these into separate issues if desired:

bielsnohr commented 2 years ago

Further to my third point above, we do actually have an 'orphaned' recipe called Explain code structure to which we currently make no reference to anywhere else on the site!!! I'll raise a separate issue for this, but it should certainly be referenced from here.

tlestang commented 2 years ago

Thanks for looking back at this. The recipe is called "Meet and agree and objectives", I thought it's fairly clear that it's about a meeting? Agreed that a sentence motivating a meeting instead of e.g. an email conversation could help.

I'll complete the second example. thanks for pointing this out.

Re broader scientific context, this was a separate step in our original flowchart, coming before "Meet and agree on objectives". I'd say this part is really about "agree on objectives". Maybe we should have one "initial meeting" with two steps: explain scientific context and agree on objectives.