Skip to content

Commit

Permalink
scaffold for new exercises
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Mar 12, 2024
1 parent 5fd09af commit 43bd9db
Show file tree
Hide file tree
Showing 6 changed files with 1,145 additions and 1,045 deletions.
34 changes: 28 additions & 6 deletions content/code-review.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,34 @@
# Practicing code review

Placeholder for an episode on code review.
We will add more details and screenshots before the course.


## Exercise

We are working on creating an exercise for code review:
- suggest a change
- review a change
- reviewer asks for an improvement
- submitter improves the pull request without having to close and open a new one
:::{exercise} Exercise: Practicing code review (25 min)

**What is familiar** from the previous workshop days:
- Creating a branch.
- Committing a change on the new branch.
- Opening and merging pull requests.

**What will be new** in this exercise:
- As a reviewer, we will learn how to ask for changes in a pull request.
- As a reviewer, we will learn how to suggest a change in a pull request.
- As a submitter, we will learn how to modify a pull request without closing and opening a new one.

**Exercise tasks**:
1. Create a new branch and one or few commits: in these improve something but also
deliberately introduce a typo and also a larger mistake which we will want to fix during the code review.
1. Open a pull request towards the main branch.
1. As a reviewer to somebody else's pull request, ask for an improvement and
also suggest a change for the small typo.
1. As the submitter, improve the pull request without having to close and open
a new one: by adding a new commit to the same branch.
1. Once the changes are addressed, merge the pull request.
:::


## Solution and walk-through

We will add this before the lesson.
Loading

0 comments on commit 43bd9db

Please sign in to comment.