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

Create a topic outline to have participants "Practice the PR Review Process" #2069

Open
daaimah123 opened this issue Aug 13, 2024 · 2 comments
Assignees
Labels
current-cohort-participant the participants can work on this issue EASY Quick or simple task MEDIUM Intermediate length or difficulty priority get this done first if possible volunteers can review Volunteers can help us review/validate.

Comments

@daaimah123
Copy link
Collaborator

daaimah123 commented Aug 13, 2024

This should be an interactive lesson with two activities whereby participants are practicing their PR Review Process. Please make clear that this lesson should be implemented by participants on a Monday or Tuesday of week 8.

The participants will also be building an application (Game with API) during week 8, to learn how to fetch API data this week concurrently. As such there should be mention of the following:

  • revisit their time management slides,
  • intentionally breaking down the work implementing and sharing it with their trio or mentor,
  • checking in with their trio or their mentor for accountability about support and progress needs.

Activity 1:

Have each of the participants get started with the exercise by having them add their name to this file. The PR should include the following:

  • Title: Pull request title should be concise but descriptive
  • Description: Contain a description of what the PR is doing
  • Visual: Labelled before-changes and after-changes screenshots of their work, in the PR description

Activity 2:

Have each participant interactively participate in the PR Review Process by creating a pull request on their feedback partner's full stack code from the previous week (week 7), and reviewing incoming changes to their own work.

Repo Owner:

  • Task 1. Have participants push up a commit that removed all comments from their full stack application from the previous week.
  • Task 2. Review (confirm or correct) the incoming changes on the feedback partner's submitted PR; they should be actively leaving comments in response to the incoming PR changes.

Collaborator:

  • Task 1. Their feedback partner should create a branch that comments what each line of code is doing in the owner's project.
  • Task 2. Create a pull request for the incoming changes to be reviewed by the project owner.

Activity 3:

Each pull request owner must address their PR feedback in a tangible, but visible way:

  • You acknowledged the comment (i.e. feedback was marked with an emoji reaction to show its accepted)
  • You replied to the comment (i.e. feedback was received by adding it to project backlog for review or by furnishing an alternative explanation which you may have originally missed)
  • You resolved the comment (i.e. feedback was immediately acted upon in PR with your new commit linked in a response to the original comment and the particular conversation marked as "Resolved")

Page where issue should live

Add the lesson here.

Type of problem

We want participants to practice reading full stack application source code that isn't their own and having the capacity to articulate how logic is broken down.

Suggested Solution

Add an overview or application statement that discusses the activity simulating a PR review process, and allowing for practice reading pre-existing code the person didn't write themselves.

Acceptance Criteria

  • Complete the above activity outline in your topic outline.
  • Include a snippet of code for the participants to review in the topic outline.
  • Include the following sections:
    • Questions to Consider
    • Prerequisites
    • Motivation or Real-World Application
    • Objectives
    • Common Mistakes / Misconceptions
    • Supplemental Materials
  • Use the vitest topic outline for formatting guidance

Supplemental Resources

@daaimah123 daaimah123 added priority get this done first if possible EASY Quick or simple task BEGINNER easier than easy - great for learning github collaboration MEDIUM Intermediate length or difficulty volunteers can review Volunteers can help us review/validate. and removed BEGINNER easier than easy - great for learning github collaboration labels Aug 13, 2024
@daaimah123 daaimah123 changed the title Create a lesson plan to have participants practice their PR Review Process Create a lesson plan to have participants "Practice the PR Review Process" Aug 13, 2024
@daaimah123 daaimah123 added the current-cohort-participant the participants can work on this issue label Aug 22, 2024
@daaimah123 daaimah123 changed the title Create a lesson plan to have participants "Practice the PR Review Process" Create a topic outline to have participants "Practice the PR Review Process" Oct 21, 2024
@ChasVanDav
Copy link
Collaborator

Please assign me to this issue @daaimah123

@daaimah123
Copy link
Collaborator Author

Congratulations on becoming a contributor! 🎉

I have assigned the issue to you, @ChasVanDav

@daaimah123 daaimah123 moved this to Grab a task!👩🏽‍💻 in Returning Grads PPW Kanban Board Dec 9, 2024
@ChasVanDav ChasVanDav moved this from Grab a task!👩🏽‍💻 to In progress ⏲️ in Returning Grads PPW Kanban Board Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current-cohort-participant the participants can work on this issue EASY Quick or simple task MEDIUM Intermediate length or difficulty priority get this done first if possible volunteers can review Volunteers can help us review/validate.
Projects
Status: In progress ⏲️
Development

No branches or pull requests

3 participants