codereview.md

Grace Shopper Sprint Meeting

(Formally known as "Code Reviews")

Overview

Both Grace Shopper and Capstone projects are intended to serve as "Job Simulations" for students. In keeping with this, Grace Shopper has two scheduled "Sprint Meetings", in which Instructors, Students and their assigned Fellow will review their project's progress, give and receive feedback on relevant code, discuss blockers, and organize tasks for the next sprint.

Please note that the following flow is recommended but not mandated. Instructors should feel free to supplement with any of their chosen personal Code Review practices

Roles

• Product Owner (Instructor)

  • Prioritizes Product features to implement

  • Directs technical implementation of Product

  • Reviews and gives feedback on project codebase

• Project Manager (Fellow)

  • Leads daily standups

  • Advises on technical implementation and task breakdown

  • Tracks team progress and reports to Product Owner

• Engineers (Students)

  • Architect, engineer, and deploy product

  • Write and assign engineering tickets within group

Sprint Meeting I

Flow + Objectives

• Project Overview (Taskboard, Git Commits, Readme)

  • Audit taskboard for sensible User Stories/task breakdown and fair distribution of tasks between engineers

  • Ensure team follows collaborative branch-based Git collaboration strategy and writes semantic commits

  • Review Project README to ensure it includes description of Product, collaborators, installation instructions and link to deployed version

  • Estimated length: 10 mins

• Code Review (API)

  • Comprehensive review of technical implementation of User, Product, Order, and OrderProduct Schemas in Sequelize, as well as Cart logic

  • Discuss tradeoffs and potential areas of technical debt in different Schema, Property, and Cart implementations

  • Instructors may give written feedback either in-line on a branch, or in a separate document which they share with students

  • Estimated Length: 25 mins

• Feature Roadmap (Tier I, Cart, Security)

  • Discuss remaining features to implement to complete Tier 1, including task breakdown and technical architecture

  • Discuss strategies for Cart logic, namely tradeoffs between localStorage and server-side implementations.

  • Discuss security best practices in Express, and relevant routes to protect

  • Estimated Length: 15 mins

• Ticket Writing

  • Fellow PM (Under Instructor Supervision) will lead the team in authoring relevant User Stories and Tasks based on the Feature Roadmap Discussions

  • Estimated Length: 10 mins