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

[Workshop] SDC: Why we review code #1348

Open
illicitonion opened this issue Feb 11, 2025 · 0 comments
Open

[Workshop] SDC: Why we review code #1348

illicitonion opened this issue Feb 11, 2025 · 0 comments

Comments

@illicitonion
Copy link
Member

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

@github-project-automation github-project-automation bot moved this to 📋 Backlog in Curriculum Planning Feb 11, 2025
@illicitonion illicitonion changed the title [Workshop] SDC: We we review code [Workshop] SDC: Why we review code Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant