Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

at beginning of "author and reviewer meet" section: move "sync/async" box, remove, or re-frame #68

Open
NickleDave opened this issue Apr 8, 2022 · 1 comment

Comments

@NickleDave
Copy link
Collaborator

from Collab22 session:
a couple comments from the Barry/David group that it's a bit distracting to start this section with an aside about sync v. async code review.

(or at least, I heard the comments that way because I also found this a bit disorienting on my read through)

Consider:

  • re-frame "code review is a process with sync + aysnc components"
  • move to the end
  • remove completely -- because this particular section focuses on a face-to-face component of our process designed specifically for researchers; could say at end something like "future reviews between this author and reviewer may move to a combination of sync/async as both become familiar with the research question + and related code"

e.g. from @lucydot (tagging people so we can hopefully give credit later)

At the beginning of the section re-frame as “code review can be split into two types: synchronous and asynchronous….” and then the box about asynchronous review (or move this box to the end of the section?).

@NickleDave
Copy link
Collaborator Author

Similarly from Cat Smith in our session:

The aside on asynchronous review could maybe be lower down. If the thought is that meeting in person is a ‘better’ option then it should probably come first.

@NickleDave NickleDave mentioned this issue Apr 21, 2022
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant