20  Code Review

Plan: You’ll walk through your a section of code you’ve written step by step and demonstrate to someone from another team that all steps are accurate.

Preparation:

In class, you will be paired with an individual from another team to review a section of each other’s code.

• Open one Github Issue in your project repository with the title “Milestone 6 Code Review” and the following content:
  • A brief description of your project research questions
  • A brief description of the planned digital artifact
• While you get started, Prof. Heggeseth will add the other team members as collaborators on your project repository so they can add comments to the Github Issue.

Process:

You will have 15 minutes to review the other individual’s code. Then you will switch roles.

• One person will talk through a section of code the wrote for their project so far and explain how they checked the accuracy of those steps.
• The other person (reviewer) will follow along, listen, ask questions, and provide suggestions. Keep in mind the following characteristics from the Code quality and documentation section of the project rubric:
  • Are functions used effectively to reduce code duplication?
  • Do functions do a single small task?
  • Are loops/purrr used appropriately to handle repeated tasks?
  • Is their clear documentation in the text before and after code chunks of what is happening in each code chunk?
  • Are code comments used to add clarity inside code chunks?
  • When using a clean dataset for modeling and/or visualization, is it clear what the cases represent and what portion (possibly a subset) of the data is being used?
• Each reviewer will write a comments/feedback in the Github Issue for the project they are reviewing that includes the following:
  • A brief description of the code you reviewed
  • A list of things that you think the authors did well
  • A list of things that you think the authors could improve
  • A list of any questions you have about the code
• After class, you should respond to the code review.
  • Include a brief description of the changes you plan to make based on the feedback.
  • Include any questions you have about the feedback.

This is part of Milestone 6 for Homework 10.

20.1 After Class

• Take a look at the Schedule page to see how to prepare for the next class
• Finish Homework 10.