Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/15-code-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -1089,6 +1089,8 @@ Chapter 15 is the **code review chapter** focused on practicing constructive fee
1. **Review a practice PR and leave 2-3 inline comments** - read the diff line by line, find specific items to comment on, and post constructive feedback.
2. **Submit a formal review verdict** - complete your review by choosing approve, request changes, or comment only.

> **No open PR to review?** The steps below assume a pull request with a diff. If your Learning Room has no open PR (or the peer simulation PR is already merged), review the sample file at `docs/code-review-sample.md` instead: read the whole file, find at least two issues (typos, headings, formatting, alt text, clarity), and post your review - one thing done well, at least one constructive suggestion, and a one-sentence verdict - as a comment on your Challenge 12 issue. A plain file has no diff, so there is no Files changed tab and no inline comment button; the issue comment is where your review lives. See the Challenge 12 issue template for the full Path B steps.

### Practice 12.1 Step-by-Step: Review a PR and Leave Inline Comments

**Goal:** Navigate a PR diff using screen reader-friendly tools and post 2-3 specific, constructive inline comments.
Expand Down
2 changes: 2 additions & 0 deletions docs/CHALLENGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ Merge Day closes the Day 1 loop. You verify that your pull request is ready, mer

**Evidence to post:** Share the merged PR link and the issue number that closed.

Before you close the issue, answer the four **Confidence Check** reflection questions from [Chapter 10](10-notifications-and-day-1-close.md#confidence-check) in a comment on your Challenge 9 issue. There are no wrong answers - this is for you.

Before moving on, scan the [Challenge 9 solution reference](https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-09-merge-day.md) to make sure you caught both the merge and verification steps.
</details>

Expand Down
3 changes: 3 additions & 0 deletions html/docs/15-code-review.html
Original file line number Diff line number Diff line change
Expand Up @@ -1399,6 +1399,9 @@ <h3 id="challenge-12-practice-set">Challenge 12 Practice Set</h3>
<li><strong>Review a practice PR and leave 2-3 inline comments</strong> - read the diff line by line, find specific items to comment on, and post constructive feedback.</li>
<li><strong>Submit a formal review verdict</strong> - complete your review by choosing approve, request changes, or comment only.</li>
</ol>
<blockquote>
<p><strong>No open PR to review?</strong> The steps below assume a pull request with a diff. If your Learning Room has no open PR (or the peer simulation PR is already merged), review the sample file at <code>docs/code-review-sample.md</code> instead: read the whole file, find at least two issues (typos, headings, formatting, alt text, clarity), and post your review - one thing done well, at least one constructive suggestion, and a one-sentence verdict - as a comment on your Challenge 12 issue. A plain file has no diff, so there is no Files changed tab and no inline comment button; the issue comment is where your review lives. See the Challenge 12 issue template for the full Path B steps.</p>
</blockquote>
<h3 id="practice-121-step-by-step-review-a-pr-and-leave-inline-comments">Practice 12.1 Step-by-Step: Review a PR and Leave Inline Comments</h3>
<p><strong>Goal:</strong> Navigate a PR diff using screen reader-friendly tools and post 2-3 specific, constructive inline comments.</p>
<p><strong>Where you are working:</strong> GitHub.com (Files changed tab of a PR) or VS Code with the GitHub Pull Requests extension.</p>
Expand Down
1 change: 1 addition & 0 deletions html/docs/CHALLENGES.html
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,7 @@ <h2 id="day-1-you-belong-here-challenges-1-9">Day 1: You Belong Here (Challenges
<li>Check that the linked issue closed automatically</li>
</ul>
<p><strong>Evidence to post:</strong> Share the merged PR link and the issue number that closed.</p>
<p>Before you close the issue, answer the four <strong>Confidence Check</strong> reflection questions from <a href="10-notifications-and-day-1-close.html#confidence-check">Chapter 10</a> in a comment on your Challenge 9 issue. There are no wrong answers - this is for you.</p>
<p>Before moving on, scan the <a href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-09-merge-day.md">Challenge 9 solution reference</a> to make sure you caught both the merge and verification steps.</p>
</details>

Expand Down
24 changes: 12 additions & 12 deletions html/search-index.json

Large diffs are not rendered by default.

69 changes: 52 additions & 17 deletions html/work.html
Original file line number Diff line number Diff line change
Expand Up @@ -907,6 +907,17 @@ <h4 id="day-1-celebration">Day 1 celebration</h4>
<li>You survived a merge conflict</li>
<li>You contributed to an open source community</li>
</ul>
<h4 id="reflect-before-you-close">Reflect before you close</h4>
<p>Before you close this issue, take two minutes to answer these questions in a comment below. There are no wrong answers - this is for you. (These are the same questions in the Chapter 10 Confidence Check, surfaced here so you see them before closing.)</p>
<ol>
<li>Which chapter felt the most natural to you? Which one do you want to revisit?</li>
<li>Can you explain what a pull request does to someone who has never used GitHub?</li>
<li>If you saw a merge conflict right now, would you know where to start?</li>
<li>What is one thing you want to try on GitHub this week that you did not get to today?</li>
</ol>
<blockquote>
<p><strong>Screen reader tip:</strong> Copy these questions into your comment and type your answers directly below each one. Use a blank line between each question-answer pair so the structure is clear when read back.</p>
</blockquote>
<hr>
<p><strong>Your evidence</strong> (fill in when closing this issue):</p>
<pre><code class="hljs language-text">My PR was merged: [link]
Expand Down Expand Up @@ -1179,16 +1190,21 @@ <h4 id="if-you-get-stuck">If you get stuck</h4>
<h3 id="challenge-12-review-like-a-pro">Challenge 12: Review Like a Pro</h3>
<p>Source template: <a href="https://github.com/Community-Access/git-going-with-github/blob/main/learning-room/.github/ISSUE_TEMPLATE/challenge-12-review.yml">challenge-12-review.yml</a></p>
<p><strong>Chapter:</strong> <a href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/15-code-review.md">Ch15: Code Review</a></p>
<p><strong>What you will do:</strong> Perform a thorough code review on a peer-simulation PR (or a buddy&#39;s PR). Use the sample file at <code>docs/code-review-sample.md</code> for your review if you do not have a real PR to review. Leave inline comments, make a suggestion, and submit a verdict.</p>
<p><strong>What you will do:</strong> Perform a thorough code review. If your Learning Room has an open pull request, review that (Path A). If it does not, review the sample file at <code>docs/code-review-sample.md</code> instead (Path B). Either way, you will leave specific feedback and a verdict.</p>
<p><strong>Why this matters:</strong> Code review is how teams maintain quality and teach each other.</p>
<h4 id="step-by-step-review-process">Step-by-step review process</h4>
<h4 id="choose-your-path">Choose your path</h4>
<ul>
<li><strong>Path A (preferred):</strong> There is an open PR in <strong>this</strong> repository to review. Use the PR workflow below.</li>
<li><strong>Path B (fallback):</strong> There is no open PR, or the only PR is already merged. Review the sample file and post your review as a comment on <strong>this</strong> issue.</li>
</ul>
<p>Not sure where to look? The peer simulation PR lives in <strong>your own Learning Room</strong> repository (the one you are in right now), not in the main workshop repository. Open the <strong>Pull requests</strong> tab here. If the <strong>Peer Simulation: Improve contribution guidance</strong> PR is missing or already merged, use Path B.</p>
<h4 id="path-a-review-a-pull-request">Path A: Review a pull request</h4>
<h4 id="step-1-find-the-pr-to-review">Step 1: Find the PR to review</h4>
<ol>
<li>Go to the <strong>Pull requests</strong> tab in this repository</li>
<li>Look for the <strong>Peer Simulation: Improve contribution guidance</strong> PR</li>
<li>Go to the <strong>Pull requests</strong> tab in <strong>this</strong> repository</li>
<li>Look for the <strong>Peer Simulation: Improve contribution guidance</strong> PR, or a classmate&#39;s open PR</li>
<li>Click to open it</li>
<li>Alternatively, if your facilitator gave you buddy access, open your buddy&#39;s Day 2 PR</li>
<li>If you do not have a real PR to review, open and review the sample file at <code>docs/code-review-sample.md</code> instead.</li>
</ol>
<h4 id="step-2-go-to-the-files-changed-tab">Step 2: Go to the Files changed tab</h4>
<ol>
Expand Down Expand Up @@ -1232,14 +1248,29 @@ <h4 id="step-3-leave-inline-comment-1-something-positive">Step 3: Leave inline c
```text
6. Click **Submit review**

#### Review checklist
#### Path B: Review the sample file (when no open PR is available)

Comment on lines 1248 to +1252
A plain Markdown file has no diff, so there is no **Files changed** tab and no inline comment button. Instead, you will read the file, find the issues, and post your review as a comment on **this Challenge 12 issue**.

When reviewing, ask yourself:
- ✅ Does it do what the PR description says?
- ✅ Is the commit message clear and meaningful?
- ✅ Are there typos or formatting issues?
- ✅ Would a beginner understand this content?
- ✅ Is the language accessible and clear?
#### Step 1: Open the sample file
1. In **this** repository, open `docs/code-review-sample.md`
2. Read the whole file. It is intentionally written with a few issues for you to find

#### Step 2: Find at least two things to comment on
Look for:
- Typos or unclear language
- Missing or incorrect headings
- Inconsistent formatting (for example, list markers that do not match)
- Missing alt text for images
- Any accessibility or clarity problems

#### Step 3: Write your review as a comment on this issue
Post a comment on **this Challenge 12 issue** that includes:
1. One thing the author did well (be specific - quote the line)
2. At least one constructive suggestion (quote the line, then suggest a fix)
3. A one-sentence verdict: would you **Approve**, **Request changes**, or **Comment** if this were a real PR, and why

This is how review works when you cannot comment inline: you describe what you found and what verdict you would give.

#### Review checklist

Expand All @@ -1263,9 +1294,9 @@ <h4 id="step-3-leave-inline-comment-1-something-positive">Step 3: Leave inline c
**Your evidence** (fill in when closing this issue):

```text
Review URL: https://github.com/...
I reviewed the peer-simulation PR.
My inline comments were about: ...
Path used: A (PR review) or B (sample file)
Review URL or comment: https://github.com/...
My feedback was about: ...
My verdict was: ... because...</code></pre>
<hr>
<h4 id="peer-simulation-check">Peer simulation check</h4>
Expand All @@ -1279,12 +1310,16 @@ <h4 id="if-you-get-stuck">If you get stuck</h4>
</tr>
</thead>
<tbody><tr>
<td>I cannot find the peer simulation PR</td>
<td>It lives in your own Learning Room, not the main workshop repo. Open the Pull requests tab here. If it is missing or merged, use Path B with <code>docs/code-review-sample.md</code>.</td>
</tr>
<tr>
<td>I cannot find the Files changed tab</td>
<td>Open the PR, then look for tabs: Conversation, Commits, Files changed. Screen reader users: these are tab links within the PR page.</td>
<td>This only exists on a PR (Path A). If you are reviewing the sample file (Path B), skip this and post your review as a comment on this issue.</td>
</tr>
<tr>
<td>I do not know how to leave an inline comment</td>
<td>Hover over (or focus on) a line number in the diff and select the blue + button that appears.</td>
<td>Hover over (or focus on) a line number in the diff and select the blue + button that appears. Path B users: there is no inline button on a plain file, so write your review as an issue comment instead.</td>
</tr>
<tr>
<td>I do not know how to suggest changes</td>
Expand Down
11 changes: 11 additions & 0 deletions learning-room/.github/ISSUE_TEMPLATE/challenge-09-merge-day.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,17 @@ body:
- You survived a merge conflict
- You contributed to an open source community

### Reflect before you close

Before you close this issue, take two minutes to answer these questions in a comment below. There are no wrong answers - this is for you. (These are the same questions in the Chapter 10 Confidence Check, surfaced here so you see them before closing.)

1. Which chapter felt the most natural to you? Which one do you want to revisit?
2. Can you explain what a pull request does to someone who has never used GitHub?
3. If you saw a merge conflict right now, would you know where to start?
4. What is one thing you want to try on GitHub this week that you did not get to today?

> **Screen reader tip:** Copy these questions into your comment and type your answers directly below each one. Use a blank line between each question-answer pair so the structure is clear when read back.

- type: textarea
id: evidence
attributes:
Expand Down
60 changes: 41 additions & 19 deletions learning-room/.github/ISSUE_TEMPLATE/challenge-12-review.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,24 @@ body:

**Chapter:** [Ch15: Code Review](https://github.com/Community-Access/git-going-with-github/blob/main/docs/15-code-review.md)

**What you will do:** Perform a thorough code review on a peer-simulation PR (or a buddy's PR). Use the sample file at `docs/code-review-sample.md` for your review if you do not have a real PR to review. Leave inline comments, make a suggestion, and submit a verdict.
**What you will do:** Perform a thorough code review. If your Learning Room has an open pull request, review that (Path A). If it does not, review the sample file at `docs/code-review-sample.md` instead (Path B). Either way, you will leave specific feedback and a verdict.

**Why this matters:** Code review is how teams maintain quality and teach each other.

### Step-by-step review process
### Choose your path

- **Path A (preferred):** There is an open PR in **this** repository to review. Use the PR workflow below.
- **Path B (fallback):** There is no open PR, or the only PR is already merged. Review the sample file and post your review as a comment on **this** issue.

Not sure where to look? The peer simulation PR lives in **your own Learning Room** repository (the one you are in right now), not in the main workshop repository. Open the **Pull requests** tab here. If the **Peer Simulation: Improve contribution guidance** PR is missing or already merged, use Path B.

### Path A: Review a pull request

**Step 1: Find the PR to review**
1. Go to the **Pull requests** tab in this repository
2. Look for the **Peer Simulation: Improve contribution guidance** PR
1. Go to the **Pull requests** tab in **this** repository
2. Look for the **Peer Simulation: Improve contribution guidance** PR, or a classmate's open PR
3. Click to open it
4. Alternatively, if your facilitator gave you buddy access, open your buddy's Day 2 PR
5. If you do not have a real PR to review, open and review the sample file at `docs/code-review-sample.md` instead.

**Step 2: Go to the Files changed tab**
1. At the top of the PR, you will see tabs: **Conversation**, **Commits**, **Files changed**, **Checks**
Expand Down Expand Up @@ -63,14 +69,29 @@ body:
```
6. Click **Submit review**

### Review checklist
### Path B: Review the sample file (when no open PR is available)

A plain Markdown file has no diff, so there is no **Files changed** tab and no inline comment button. Instead, you will read the file, find the issues, and post your review as a comment on **this Challenge 12 issue**.

**Step 1: Open the sample file**
1. In **this** repository, open `docs/code-review-sample.md`
2. Read the whole file. It is intentionally written with a few issues for you to find

**Step 2: Find at least two things to comment on**
Look for:
- Typos or unclear language
- Missing or incorrect headings
- Inconsistent formatting (for example, list markers that do not match)
- Missing alt text for images
- Any accessibility or clarity problems

**Step 3: Write your review as a comment on this issue**
Post a comment on **this Challenge 12 issue** that includes:
1. One thing the author did well (be specific - quote the line)
2. At least one constructive suggestion (quote the line, then suggest a fix)
3. A one-sentence verdict: would you **Approve**, **Request changes**, or **Comment** if this were a real PR, and why

When reviewing, ask yourself:
- ✅ Does it do what the PR description says?
- ✅ Is the commit message clear and meaningful?
- ✅ Are there typos or formatting issues?
- ✅ Would a beginner understand this content?
- ✅ Is the language accessible and clear?
This is how review works when you cannot comment inline: you describe what you found and what verdict you would give.

### Review checklist

Expand All @@ -93,11 +114,11 @@ body:
id: evidence
attributes:
label: "Your evidence"
description: "Paste the URL of your review and describe what feedback you gave."
description: "If you used Path A, paste the URL of your review. If you used Path B, paste the review comment you posted on this issue."
placeholder: |
Review URL: https://github.com/...
I reviewed the peer-simulation PR.
My inline comments were about: ...
Path used: A (PR review) or B (sample file)
Review URL or comment: https://github.com/...
My feedback was about: ...
My verdict was: ... because...
validations:
required: true
Expand All @@ -113,8 +134,9 @@ body:

| Symptom | Try this |
|---|---|
| I cannot find the Files changed tab | Open the PR, then look for tabs: Conversation, Commits, Files changed. Screen reader users: these are tab links within the PR page. |
| I do not know how to leave an inline comment | Hover over (or focus on) a line number in the diff and select the blue + button that appears. |
| I cannot find the peer simulation PR | It lives in your own Learning Room, not the main workshop repo. Open the Pull requests tab here. If it is missing or merged, use Path B with `docs/code-review-sample.md`. |
| I cannot find the Files changed tab | This only exists on a PR (Path A). If you are reviewing the sample file (Path B), skip this and post your review as a comment on this issue. |
| I do not know how to leave an inline comment | Hover over (or focus on) a line number in the diff and select the blue + button that appears. Path B users: there is no inline button on a plain file, so write your review as an issue comment instead. |
| I do not know how to suggest changes | In the comment box, select the file-diff icon (it looks like +/-) to create a suggestion block. Edit the code inside the block. |
| I am not sure which verdict to give | When in doubt, use **Comment**. It gives feedback without blocking. |
| I finished but want to check my work | [View the reference solution](https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-12-review.md) |
| I finished but want to check my work | [View the reference solution](https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-12-review.md) |
Loading
Loading