Skip to content

Commit 6a149e2

Browse files
author
GitHub Workshop Bot
committed
Challenge 10/11: use README.md in sci-fi repo, sync all templates and docs
1 parent a757936 commit 6a149e2

11 files changed

Lines changed: 109 additions & 120 deletions

File tree

‎.github/ISSUE_TEMPLATE/challenge-10-go-local.yml‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ body:
1111
1212
**Chapters:** [Ch11: VS Code Interface](https://github.com/Community-Access/git-going-with-github/blob/main/docs/11-vscode-interface.md) | [Ch13: How Git Works](https://github.com/Community-Access/git-going-with-github/blob/main/docs/13-how-git-works.md) | [Ch14: Git in Practice](https://github.com/Community-Access/git-going-with-github/blob/main/docs/14-git-in-practice.md)
1313
14-
**What you will do:** Clone the learning-room to your computer, create a feature branch, make an edit, commit locally, and push to GitHub.
14+
**What you will do:** Clone the sci-fi themes repo to your computer, create a feature branch, make an edit to the README.md file, commit locally, and push to GitHub.
1515
1616
### The local workflow
1717
@@ -42,19 +42,17 @@ body:
4242
4. Press Enter
4343
4444
**Step 3: Edit a file**
45-
1. In the explorer on the left, navigate to `docs/`
46-
2. Open any file in the `docs/` folder
47-
3. Find a typo, improve a sentence, or add a helpful comment
48-
4. Make a small, meaningful change (just 1-2 lines)
45+
1. In the explorer on the left, open `README.md`
46+
2. Add a comment, fix a typo, or improve a sentence (just 1-2 lines)
4947
5048
**Step 4: Commit your change**
5149
1. Press Ctrl+Shift+G to open the Source Control panel
5250
2. You will see your modified file listed
5351
3. Select the **+** next to it to **Stage** the change
54-
4. In the message field at the top, write a commit message:
55-
```
56-
fix: correct typo in chapter 5
57-
```
52+
4. In the message field at the top, write a commit message:
53+
```
54+
docs: improve README wording
55+
```
5856
5. Press Ctrl+Enter (or select the checkmark) to **Commit**
5957
6058
**Step 5: Push to GitHub**
@@ -70,7 +68,7 @@ body:
7068
**Step 1: Clone the repository**
7169
1. Open GitHub Desktop
7270
2. Choose File > Clone Repository
73-
3. Paste the URL: `https://github.com/Community-Access/learning-room.git`
71+
3. Paste the URL: `https://github.com/Community-Access/vscode-sci-fi-themes.git`
7472
4. Choose a folder location
7573
5. Select Clone
7674
@@ -83,13 +81,13 @@ body:
8381
8482
**Step 3: Edit a file**
8583
1. Select **Show in Explorer** to open the folder
86-
2. Navigate to `docs/`
87-
3. Open any file and make a small improvement (fix typo, improve wording, add comment)
84+
2. Open `README.md`
85+
3. Add a comment, fix a typo, or improve a sentence
8886
8987
**Step 4: Commit your change**
9088
1. Go back to GitHub Desktop
9189
2. You should see your change listed
92-
3. At the bottom-left, write a commit message: `fix: correct typo in chapter 5`
90+
3. At the bottom-left, write a commit message: `docs: improve README wording`
9391
4. Select **Commit to fix/YOUR-USERNAME**
9492
9593
**Step 5: Push to GitHub**

‎.github/ISSUE_TEMPLATE/challenge-11-day2-pr.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ body:
2424
### Step-by-step instructions
2525
2626
**Step 1: Check for a notification banner**
27-
1. Go to the learning-room repository on GitHub.com
27+
1. Go to the sci-fi themes repository on GitHub.com
2828
2. You may see a notification banner at the top saying "Your branch had recent pushes"
2929
3. If so, select **Compare & pull request** - this is a shortcut
3030
4. Skip to Step 3
@@ -39,16 +39,16 @@ body:
3939
**Step 3: Write your PR title**
4040
Write a clear, specific title about what you changed:
4141
```
42-
Fix typo in chapter 5 documentation
42+
docs: improve README wording
4343
```
4444
4545
**Step 4: Write your PR description**
4646
```
4747
## What this PR does
48-
Fixes a typo in the chapter 5 file that was confusing readers.
48+
Improves the README by clarifying the instructions and fixing a typo.
4949
5050
## Why
51-
Clear documentation helps new developers learn faster.
51+
Clear documentation helps new developers and theme users understand the project.
5252
```
5353
5454
**Step 5: Submit**

‎admin/qa-bundle/html/work.html‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -795,7 +795,7 @@ <h3 id="day-1-celebration">Day 1 celebration</h3>
795795
<h3 id="challenge-10-go-local">Challenge 10: Go Local</h3>
796796
<p>Source template: <a href="learning-room/.github/ISSUE_TEMPLATE/challenge-10-go-local.yml">challenge-10-go-local.yml</a></p>
797797
<p><strong>Chapters:</strong> <a href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/11-vscode-interface.md">Ch11: VS Code Interface</a> | <a href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/13-how-git-works.md">Ch13: How Git Works</a> | <a href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/14-git-in-practice.md">Ch14: Git in Practice</a></p>
798-
<p><strong>What you will do:</strong> Clone the learning-room to your computer, create a feature branch, make an edit, commit locally, and push to GitHub.</p>
798+
<p><strong>What you will do:</strong> Clone the sci-fi themes repo to your computer, create a feature branch, make an edit to the README.md file, commit locally, and push to GitHub.</p>
799799
<h3 id="the-local-workflow">The local workflow</h3>
800800
<p>This is the professional Git workflow you will use for the rest of your career:</p>
801801
<ol>
@@ -825,18 +825,16 @@ <h3 id="choose-your-tool-and-follow-the-steps">Choose your tool and follow the s
825825
</ol>
826826
<p><strong>Step 3: Edit a file</strong></p>
827827
<ol>
828-
<li>In the explorer on the left, navigate to <code>docs/</code></li>
829-
<li>Open any file in the <code>docs/</code> folder</li>
830-
<li>Find a typo, improve a sentence, or add a helpful comment</li>
831-
<li>Make a small, meaningful change (just 1-2 lines)</li>
828+
<li>In the explorer on the left, open <code>README.md</code></li>
829+
<li>Add a comment, fix a typo, or improve a sentence (just 1-2 lines)</li>
832830
</ol>
833831
<p><strong>Step 4: Commit your change</strong></p>
834832
<ol>
835833
<li>Press Ctrl+Shift+G to open the Source Control panel</li>
836834
<li>You will see your modified file listed</li>
837835
<li>Select the <strong>+</strong> next to it to <strong>Stage</strong> the change</li>
838-
<li>In the message field at the top, write a commit message:<pre><code class="hljs"><span class="hljs-attribute">fix</span>: correct typo in chapter <span class="hljs-number">5</span></code></pre>
839-
</li>
836+
<li>In the message field at the top, write a commit message:
837+
<code>docs: improve README wording</code></li>
840838
<li>Press Ctrl+Enter (or select the checkmark) to <strong>Commit</strong></li>
841839
</ol>
842840
<p><strong>Step 5: Push to GitHub</strong></p>
@@ -852,7 +850,7 @@ <h3 id="choose-your-tool-and-follow-the-steps">Choose your tool and follow the s
852850
<ol>
853851
<li>Open GitHub Desktop</li>
854852
<li>Choose File &gt; Clone Repository</li>
855-
<li>Paste the URL: <code>https://github.com/Community-Access/learning-room.git</code></li>
853+
<li>Paste the URL: <code>https://github.com/Community-Access/vscode-sci-fi-themes.git</code></li>
856854
<li>Choose a folder location</li>
857855
<li>Select Clone</li>
858856
</ol>
@@ -867,14 +865,14 @@ <h3 id="choose-your-tool-and-follow-the-steps">Choose your tool and follow the s
867865
<p><strong>Step 3: Edit a file</strong></p>
868866
<ol>
869867
<li>Select <strong>Show in Explorer</strong> to open the folder</li>
870-
<li>Navigate to <code>docs/</code></li>
871-
<li>Open any file and make a small improvement (fix typo, improve wording, add comment)</li>
868+
<li>Open <code>README.md</code></li>
869+
<li>Add a comment, fix a typo, or improve a sentence</li>
872870
</ol>
873871
<p><strong>Step 4: Commit your change</strong></p>
874872
<ol>
875873
<li>Go back to GitHub Desktop</li>
876874
<li>You should see your change listed</li>
877-
<li>At the bottom-left, write a commit message: <code>fix: correct typo in chapter 5</code></li>
875+
<li>At the bottom-left, write a commit message: <code>docs: improve README wording</code></li>
878876
<li>Select <strong>Commit to fix/YOUR-USERNAME</strong></li>
879877
</ol>
880878
<p><strong>Step 5: Push to GitHub</strong></p>
@@ -916,7 +914,7 @@ <h3 id="the-workflow-pattern">The workflow pattern</h3>
916914
<h3 id="step-by-step-instructions">Step-by-step instructions</h3>
917915
<p><strong>Step 1: Check for a notification banner</strong></p>
918916
<ol>
919-
<li>Go to the learning-room repository on GitHub.com</li>
917+
<li>Go to the sci-fi themes repository on GitHub.com</li>
920918
<li>You may see a notification banner at the top saying &quot;Your branch had recent pushes&quot;</li>
921919
<li>If so, select <strong>Compare &amp; pull request</strong> - this is a shortcut</li>
922920
<li>Skip to Step 3</li>
@@ -931,13 +929,13 @@ <h3 id="step-by-step-instructions">Step-by-step instructions</h3>
931929
</ol>
932930
<p><strong>Step 3: Write your PR title</strong>
933931
Write a clear, specific title about what you changed:</p>
934-
<pre><code class="hljs"><span class="hljs-attribute">Fix</span> typo in chapter <span class="hljs-number">5</span> documentation</code></pre>
932+
<pre><code class="hljs"><span class="hljs-symbol">docs:</span> improve README wording</code></pre>
935933
<p><strong>Step 4: Write your PR description</strong></p>
936934
<pre><code class="hljs"><span class="hljs-comment">## What this PR does</span>
937-
Fixes <span class="hljs-keyword">a</span> typo <span class="hljs-keyword">in</span> <span class="hljs-keyword">the</span> chapter <span class="hljs-number">5</span> <span class="hljs-built_in">file</span> that was confusing readers.
935+
Improves <span class="hljs-keyword">the</span> README <span class="hljs-keyword">by</span> clarifying <span class="hljs-keyword">the</span> instructions <span class="hljs-keyword">and</span> fixing <span class="hljs-keyword">a</span> typo.
938936

939937
<span class="hljs-comment">## Why</span>
940-
Clear documentation helps <span class="hljs-built_in">new</span> developers learn faster.</code></pre>
938+
Clear documentation helps <span class="hljs-built_in">new</span> developers <span class="hljs-keyword">and</span> theme users understand <span class="hljs-keyword">the</span> project.</code></pre>
941939
<p><strong>Step 5: Submit</strong></p>
942940
<ol>
943941
<li>Select <strong>Create pull request</strong></li>

‎admin/qa-bundle/learning-room/.github/ISSUE_TEMPLATE/challenge-10-go-local.yml‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ body:
1111
1212
**Chapters:** [Ch11: VS Code Interface](https://github.com/Community-Access/git-going-with-github/blob/main/docs/11-vscode-interface.md) | [Ch13: How Git Works](https://github.com/Community-Access/git-going-with-github/blob/main/docs/13-how-git-works.md) | [Ch14: Git in Practice](https://github.com/Community-Access/git-going-with-github/blob/main/docs/14-git-in-practice.md)
1313
14-
**What you will do:** Clone the learning-room to your computer, create a feature branch, make an edit, commit locally, and push to GitHub.
14+
**What you will do:** Clone the sci-fi themes repo to your computer, create a feature branch, make an edit to the README.md file, commit locally, and push to GitHub.
1515
1616
### The local workflow
1717
@@ -42,19 +42,17 @@ body:
4242
4. Press Enter
4343
4444
**Step 3: Edit a file**
45-
1. In the explorer on the left, navigate to `docs/`
46-
2. Open any file in the `docs/` folder
47-
3. Find a typo, improve a sentence, or add a helpful comment
48-
4. Make a small, meaningful change (just 1-2 lines)
45+
1. In the explorer on the left, open `README.md`
46+
2. Add a comment, fix a typo, or improve a sentence (just 1-2 lines)
4947
5048
**Step 4: Commit your change**
5149
1. Press Ctrl+Shift+G to open the Source Control panel
5250
2. You will see your modified file listed
5351
3. Select the **+** next to it to **Stage** the change
54-
4. In the message field at the top, write a commit message:
55-
```
56-
fix: correct typo in chapter 5
57-
```
52+
4. In the message field at the top, write a commit message:
53+
```
54+
docs: improve README wording
55+
```
5856
5. Press Ctrl+Enter (or select the checkmark) to **Commit**
5957
6058
**Step 5: Push to GitHub**
@@ -70,7 +68,7 @@ body:
7068
**Step 1: Clone the repository**
7169
1. Open GitHub Desktop
7270
2. Choose File > Clone Repository
73-
3. Paste the URL: `https://github.com/Community-Access/learning-room.git`
71+
3. Paste the URL: `https://github.com/Community-Access/vscode-sci-fi-themes.git`
7472
4. Choose a folder location
7573
5. Select Clone
7674
@@ -83,13 +81,13 @@ body:
8381
8482
**Step 3: Edit a file**
8583
1. Select **Show in Explorer** to open the folder
86-
2. Navigate to `docs/`
87-
3. Open any file and make a small improvement (fix typo, improve wording, add comment)
84+
2. Open `README.md`
85+
3. Add a comment, fix a typo, or improve a sentence
8886
8987
**Step 4: Commit your change**
9088
1. Go back to GitHub Desktop
9189
2. You should see your change listed
92-
3. At the bottom-left, write a commit message: `fix: correct typo in chapter 5`
90+
3. At the bottom-left, write a commit message: `docs: improve README wording`
9391
4. Select **Commit to fix/YOUR-USERNAME**
9492
9593
**Step 5: Push to GitHub**

‎admin/qa-bundle/learning-room/.github/ISSUE_TEMPLATE/challenge-11-day2-pr.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ body:
2424
### Step-by-step instructions
2525
2626
**Step 1: Check for a notification banner**
27-
1. Go to the learning-room repository on GitHub.com
27+
1. Go to the sci-fi themes repository on GitHub.com
2828
2. You may see a notification banner at the top saying "Your branch had recent pushes"
2929
3. If so, select **Compare & pull request** - this is a shortcut
3030
4. Skip to Step 3
@@ -39,16 +39,16 @@ body:
3939
**Step 3: Write your PR title**
4040
Write a clear, specific title about what you changed:
4141
```
42-
Fix typo in chapter 5 documentation
42+
docs: improve README wording
4343
```
4444
4545
**Step 4: Write your PR description**
4646
```
4747
## What this PR does
48-
Fixes a typo in the chapter 5 file that was confusing readers.
48+
Improves the README by clarifying the instructions and fixing a typo.
4949
5050
## Why
51-
Clear documentation helps new developers learn faster.
51+
Clear documentation helps new developers and theme users understand the project.
5252
```
5353
5454
**Step 5: Submit**

‎admin/qa-bundle/work.md‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,7 @@ Source template: [challenge-10-go-local.yml](learning-room/.github/ISSUE_TEMPLAT
592592

593593
**Chapters:** [Ch11: VS Code Interface](https://github.com/Community-Access/git-going-with-github/blob/main/docs/11-vscode-interface.md) | [Ch13: How Git Works](https://github.com/Community-Access/git-going-with-github/blob/main/docs/13-how-git-works.md) | [Ch14: Git in Practice](https://github.com/Community-Access/git-going-with-github/blob/main/docs/14-git-in-practice.md)
594594

595-
**What you will do:** Clone the learning-room to your computer, create a feature branch, make an edit, commit locally, and push to GitHub.
595+
**What you will do:** Clone the sci-fi themes repo to your computer, create a feature branch, make an edit to the README.md file, commit locally, and push to GitHub.
596596

597597
### The local workflow
598598

@@ -623,19 +623,17 @@ This is the professional Git workflow you will use for the rest of your career:
623623
4. Press Enter
624624

625625
**Step 3: Edit a file**
626-
1. In the explorer on the left, navigate to `docs/`
627-
2. Open any file in the `docs/` folder
628-
3. Find a typo, improve a sentence, or add a helpful comment
629-
4. Make a small, meaningful change (just 1-2 lines)
626+
1. In the explorer on the left, open `README.md`
627+
2. Add a comment, fix a typo, or improve a sentence (just 1-2 lines)
630628

631629
**Step 4: Commit your change**
632630
1. Press Ctrl+Shift+G to open the Source Control panel
633631
2. You will see your modified file listed
634632
3. Select the **+** next to it to **Stage** the change
635-
4. In the message field at the top, write a commit message:
636-
```
637-
fix: correct typo in chapter 5
638-
```
633+
4. In the message field at the top, write a commit message:
634+
```
635+
docs: improve README wording
636+
```
639637
5. Press Ctrl+Enter (or select the checkmark) to **Commit**
640638
641639
**Step 5: Push to GitHub**
@@ -651,7 +649,7 @@ This is the professional Git workflow you will use for the rest of your career:
651649
**Step 1: Clone the repository**
652650
1. Open GitHub Desktop
653651
2. Choose File > Clone Repository
654-
3. Paste the URL: `https://github.com/Community-Access/learning-room.git`
652+
3. Paste the URL: `https://github.com/Community-Access/vscode-sci-fi-themes.git`
655653
4. Choose a folder location
656654
5. Select Clone
657655
@@ -664,13 +662,13 @@ This is the professional Git workflow you will use for the rest of your career:
664662
665663
**Step 3: Edit a file**
666664
1. Select **Show in Explorer** to open the folder
667-
2. Navigate to `docs/`
668-
3. Open any file and make a small improvement (fix typo, improve wording, add comment)
665+
2. Open `README.md`
666+
3. Add a comment, fix a typo, or improve a sentence
669667
670668
**Step 4: Commit your change**
671669
1. Go back to GitHub Desktop
672670
2. You should see your change listed
673-
3. At the bottom-left, write a commit message: `fix: correct typo in chapter 5`
671+
3. At the bottom-left, write a commit message: `docs: improve README wording`
674672
4. Select **Commit to fix/YOUR-USERNAME**
675673
676674
**Step 5: Push to GitHub**
@@ -723,7 +721,7 @@ The PR creation step is the same. Git just moves you between locations.
723721
### Step-by-step instructions
724722

725723
**Step 1: Check for a notification banner**
726-
1. Go to the learning-room repository on GitHub.com
724+
1. Go to the sci-fi themes repository on GitHub.com
727725
2. You may see a notification banner at the top saying "Your branch had recent pushes"
728726
3. If so, select **Compare & pull request** - this is a shortcut
729727
4. Skip to Step 3
@@ -738,16 +736,16 @@ The PR creation step is the same. Git just moves you between locations.
738736
**Step 3: Write your PR title**
739737
Write a clear, specific title about what you changed:
740738
```
741-
Fix typo in chapter 5 documentation
739+
docs: improve README wording
742740
```
743741

744742
**Step 4: Write your PR description**
745743
```
746744
## What this PR does
747-
Fixes a typo in the chapter 5 file that was confusing readers.
745+
Improves the README by clarifying the instructions and fixing a typo.
748746
749747
## Why
750-
Clear documentation helps new developers learn faster.
748+
Clear documentation helps new developers and theme users understand the project.
751749
```
752750

753751
**Step 5: Submit**

0 commit comments

Comments
 (0)