Lab Meeting Code Review

Abbreviated Code Reviews

Abbreviated code reviews conducted during lab meetings are designed to be lightweight and require no advance preparation from reviewers.

Format

Each presenter in lab meeting will share: - Their scientific work or a helpful topic (10-15 min) - Relevant code to the above, or other code the presenter has been working on (10-15 min)

The presenter leads the session, walking through their topic and their code (including explaining the code's context).

Purpose

• These sessions are meant to provide focused, constructive feedback
• Given the limited time, presenters are encouraged to request specific feedback areas (see Suggested Reviewer Feedback under [General Guidelines For Reviewers]](code_review/general_code_review.md/) for examples)

Guidelines for Presenters

• Code shared often relates to previously discussed scientific topics, but is not a requirement
• Choose code where feedback will be most beneficial to your work

Structure

• 10-10:30: Intros/Ice Breaker
• 10:30 - 11:00: 1st Presenter
  • 10:30-10:40: Present Science (or other topic helpful to presenter)
  • 10:40-10:45: Presenter Introduces Code
    • Expected Output/Goal
    • Describe the Inputs
    • Provide code
    • Optional: Provide Example Input
  • 10:45-10:55: Independent Review of Presenter’s Code
    • Will likely have time to evaluate code in 1 or 2 of the ways suggested earlier
  • 10:55-11:00: Feedback, Questions, Discussion on Science and Code
    • Send specific “to-dos” or changes to the developer via Slack OR as issues on GitHub
    • Provide positive praise (may be done via chat)
• 11:00 - 11:30: 2nd Presenter

Example Code Review

This video is an example of what a lab meeting code review might look like. It is based on when we provided 30 minutes for code review, so either use your whole time in this way, or shorten to what fits your needs best. For access, please message Jessica on Slack.