CodeYourFuture / CodeYourFuture/curriculum

[Workshop] SDC: Why we review code

Open
#1,348 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
76
Forks
135
Avg merge
1d 3h
Merged PRs (30d)
20

Description

# Workshop Request

## What is the title of your workshop

We we review code

## What are the key topics that will be covered in the workshop?

* Different reasons we do code review (e.g. looking for bugs, sharing understanding/context, learning, teaching)
* Why we do code review at CYF (e.g. to teach/learn, to prepare for a professional skill, to practice git)
* What are objectives are of code review at CYF (producing perfect PRs, solidifying understanding)
* How to get the most value out of code review (e.g. responding to comments in code or text, responding promptly, asking for review if we're not getting any)

## What knowledge does the trainee need before starting?

* Familiarity with the GitHub PR interface.
* Has received at least one code review.

## What are the topics that will **not** be covered in the workshop?

Any details of code itself - we're just talking about process not content.

## Any other notes?

Ideally I'd like this to fit inside 45 minutes

## Completion

When completed the lesson plan and exercises should be added as a markdown file to https://github.com/CodeYourFuture/CYF-Workshops

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.