Skip to content

Commit 444fbe0

Browse files
accesswatchGitHub Workshop Botclaude
authored
docs(challenge-06): add missing Create pull request step on the compare page (#247)
A learner following Challenge 6 reached the compare view and found no title or description form because the instructions jump from choosing base and compare straight to writing a title (support#60). Add the intermediate Create pull request button step with screen reader navigation hints, explain why the comparison preview reads long, and add a matching row to the stuck table and the chapter's screen reader tool card. Co-authored-by: GitHub Workshop Bot <workshop@example.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 720aa8a commit 444fbe0

6 files changed

Lines changed: 33 additions & 22 deletions

File tree

docs/06-working-with-pull-requests.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -863,6 +863,7 @@ gh pr create --title "Your title" --body "Description"
863863
2. A "Compare & pull request" banner may appear (if you recently pushed) - activate it
864864
3. OR: Navigate to Pull Requests tab → "New pull request"
865865
4. Choose your base branch (what to merge into) and compare branch (your changes)
866+
5. Activate the **Create pull request** button. It sits between the branch choosers and the diff, and the title and description form appears only after you activate it. Use the button quick navigation key (B in NVDA and JAWS browse mode) or search the page for "Create pull request". The comparison preview can read as very long because it includes unchanged context lines - the form is above it, not below it.
866867

867868
</details>
868869

html/docs/06-working-with-pull-requests.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1149,6 +1149,7 @@ <h3 id="from-a-fork-or-feature-branch">From a fork or feature branch</h3>
11491149
<li>A &quot;Compare &amp; pull request&quot; banner may appear (if you recently pushed) - activate it</li>
11501150
<li>OR: Navigate to Pull Requests tab → &quot;New pull request&quot;</li>
11511151
<li>Choose your base branch (what to merge into) and compare branch (your changes)</li>
1152+
<li>Activate the <strong>Create pull request</strong> button. It sits between the branch choosers and the diff, and the title and description form appears only after you activate it. Use the button quick navigation key (B in NVDA and JAWS browse mode) or search the page for &quot;Create pull request&quot;. The comparison preview can read as very long because it includes unchanged context lines - the form is above it, not below it.</li>
11521153
</ol>
11531154
</details>
11541155

html/search-index.json

Lines changed: 12 additions & 12 deletions
Large diffs are not rendered by default.

html/work.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -591,10 +591,11 @@ <h4 id="instructions">Instructions</h4>
591591
<ol>
592592
<li>Go to the <strong>Pull requests</strong> tab.</li>
593593
<li>Select <strong>New pull request</strong>.</li>
594-
<li>Set <strong>base</strong> to <code>main</code> and <strong>compare</strong> to <code>learn/YOUR-USERNAME</code>.</li>
594+
<li>Set <strong>base</strong> to <code>main</code> and <strong>compare</strong> to <code>learn/YOUR-USERNAME</code>. The page shows a preview of your commits and changed files. This preview can read as very long because it includes unchanged context lines around each change - that is normal.</li>
595+
<li>Activate the <strong>Create pull request</strong> button. It sits between the branch choosers and the diff, and the title and description fields do not appear until you activate it. With a screen reader, use the button quick navigation key (B in NVDA and JAWS browse mode) or search the page for &quot;Create pull request&quot;.</li>
595596
<li>Write a descriptive PR title.</li>
596597
<li>In the PR description, include <code>Closes #XX</code> (replace XX with your Challenge 2 issue number). This automatically links and closes the issue when the PR is merged.</li>
597-
<li>Submit the pull request.</li>
598+
<li>Submit by activating the <strong>Create pull request</strong> button below the description field.</li>
598599
</ol>
599600
<h4 id="pr-description-template">PR description template</h4>
600601
<p>Use this structure for your PR description:</p>
@@ -638,6 +639,10 @@ <h4 id="if-you-get-stuck">If you get stuck</h4>
638639
<td>Make sure you are on the Pull requests tab. The button is near the top-right.</td>
639640
</tr>
640641
<tr>
642+
<td>The diff appears but there is no title or description field</td>
643+
<td>The compare page shows only a preview at first. Activate the <strong>Create pull request</strong> button between the branch choosers and the diff to open the form.</td>
644+
</tr>
645+
<tr>
641646
<td>It says &quot;There isn&#39;t anything to compare&quot;</td>
642647
<td>Make sure your branch has at least one commit that differs from main. Did you commit to the right branch?</td>
643648
</tr>

learning-room/.github/ISSUE_TEMPLATE/challenge-06-first-pr.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ body:
1616
1717
1. Go to the **Pull requests** tab.
1818
2. Select **New pull request**.
19-
3. Set **base** to `main` and **compare** to `learn/YOUR-USERNAME`.
20-
4. Write a descriptive PR title.
21-
5. In the PR description, include `Closes #XX` (replace XX with your Challenge 2 issue number). This automatically links and closes the issue when the PR is merged.
22-
6. Submit the pull request.
19+
3. Set **base** to `main` and **compare** to `learn/YOUR-USERNAME`. The page shows a preview of your commits and changed files. This preview can read as very long because it includes unchanged context lines around each change - that is normal.
20+
4. Activate the **Create pull request** button. It sits between the branch choosers and the diff, and the title and description fields do not appear until you activate it. With a screen reader, use the button quick navigation key (B in NVDA and JAWS browse mode) or search the page for "Create pull request".
21+
5. Write a descriptive PR title.
22+
6. In the PR description, include `Closes #XX` (replace XX with your Challenge 2 issue number). This automatically links and closes the issue when the PR is merged.
23+
7. Submit by activating the **Create pull request** button below the description field.
2324
2425
### PR description template
2526
@@ -66,6 +67,7 @@ body:
6667
| Symptom | Try this |
6768
|---|---|
6869
| I cannot find the New pull request button | Make sure you are on the Pull requests tab. The button is near the top-right. |
70+
| The diff appears but there is no title or description field | The compare page shows only a preview at first. Activate the **Create pull request** button between the branch choosers and the diff to open the form. |
6971
| It says "There isn't anything to compare" | Make sure your branch has at least one commit that differs from main. Did you commit to the right branch? |
7072
| I forgot to include `Closes #XX` | Edit your PR description after creating it. Select the three-dot menu or the Edit button on the description. |
7173
| 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-06-first-pr.md) |

work.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -316,10 +316,11 @@ Source template: [challenge-06-first-pr.yml](https://github.com/Community-Access
316316

317317
1. Go to the **Pull requests** tab.
318318
2. Select **New pull request**.
319-
3. Set **base** to `main` and **compare** to `learn/YOUR-USERNAME`.
320-
4. Write a descriptive PR title.
321-
5. In the PR description, include `Closes #XX` (replace XX with your Challenge 2 issue number). This automatically links and closes the issue when the PR is merged.
322-
6. Submit the pull request.
319+
3. Set **base** to `main` and **compare** to `learn/YOUR-USERNAME`. The page shows a preview of your commits and changed files. This preview can read as very long because it includes unchanged context lines around each change - that is normal.
320+
4. Activate the **Create pull request** button. It sits between the branch choosers and the diff, and the title and description fields do not appear until you activate it. With a screen reader, use the button quick navigation key (B in NVDA and JAWS browse mode) or search the page for "Create pull request".
321+
5. Write a descriptive PR title.
322+
6. In the PR description, include `Closes #XX` (replace XX with your Challenge 2 issue number). This automatically links and closes the issue when the PR is merged.
323+
7. Submit by activating the **Create pull request** button below the description field.
323324

324325
#### PR description template
325326

@@ -363,6 +364,7 @@ Find the **Peer Simulation: Improve contribution guidance** PR and leave an enco
363364
| Symptom | Try this |
364365
|---|---|
365366
| I cannot find the New pull request button | Make sure you are on the Pull requests tab. The button is near the top-right. |
367+
| The diff appears but there is no title or description field | The compare page shows only a preview at first. Activate the **Create pull request** button between the branch choosers and the diff to open the form. |
366368
| It says "There isn't anything to compare" | Make sure your branch has at least one commit that differs from main. Did you commit to the right branch? |
367369
| I forgot to include `Closes #XX` | Edit your PR description after creating it. Select the three-dot menu or the Edit button on the description. |
368370
| 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-06-first-pr.md) |

0 commit comments

Comments
 (0)