-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathwork.html
More file actions
2402 lines (2314 loc) · 99.1 KB
/
work.html
File metadata and controls
2402 lines (2314 loc) · 99.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<h1 id="work.md">Work.md</h1>
<p>Consolidated walkthrough generated from the challenge issue templates
in <code>learning-room/.github/ISSUE_TEMPLATE/</code>. Do not edit this
file manually. Run <code>npm run build:html</code> (or
<code>node scripts/generate-work-md.js</code>) to regenerate.</p>
<h2 id="core-challenges">Core challenges</h2>
<h3 id="challenge-1-find-your-way-around">Challenge 1: Find Your Way
Around</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-01-find-your-way.yml">challenge-01-find-your-way.yml</a></p>
<p><strong>Chapters:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/02-understanding-github.md">Ch02:
Understanding GitHub</a> | <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/03-navigating-repositories.md">Ch03:
Navigating Repositories</a> | <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/04-the-learning-room.md">Ch04:
The Learning Room</a></p>
<p><strong>What you will do:</strong> Explore this learning-room
repository like a scavenger hunt. You will navigate tabs, the file tree,
read key files, and find landmarks.</p>
<h4 id="step-by-step-scavenger-hunt">Step-by-step scavenger hunt</h4>
<h4 id="task-1-count-files-in-the-root">Task 1: Count files in the
root</h4>
<ol type="1">
<li>Make sure you are on the <strong>Code</strong> tab (click it at the
top)</li>
<li>Look at the file/folder list</li>
<li>Count how many items are showing (stop before the first folder)</li>
<li>Write down this number</li>
</ol>
<h4 id="task-2-find-an-open-issue">Task 2: Find an open issue</h4>
<ol type="1">
<li>Click the <strong>Issues</strong> tab</li>
<li>Look for issues with a green <strong>Open</strong> label</li>
<li>Click on one to read it</li>
<li>Write down its title</li>
</ol>
<h4 id="task-3-read-welcome.md">Task 3: Read welcome.md</h4>
<ol type="1">
<li>Click the <strong>Code</strong> tab</li>
<li>Look for a folder named <code>docs/</code></li>
<li>Click to open it</li>
<li>Find <code>welcome.md</code> and click it</li>
<li>Read the first paragraph (the opening sentence)</li>
<li>Write down what it says</li>
</ol>
<h4 id="task-4-find-the-repo-description">Task 4: Find the repo
description</h4>
<ol type="1">
<li>Go to the <strong>Code</strong> tab</li>
<li>Look at the top-right area - you should see a text description under
the repo name</li>
<li>This is the “About” section</li>
<li>Write down what it says</li>
</ol>
<h4 id="task-5-read-the-readme">Task 5: Read the README</h4>
<ol type="1">
<li>On the <strong>Code</strong> tab, scroll down to find
<code>README.md</code></li>
<li>Click it to open</li>
<li>Find the section that says “Who this workshop is for”</li>
<li>Write down the answer</li>
</ol>
<h4 id="task-6-check-the-about-section">Task 6: Check the About
section</h4>
<ol type="1">
<li>On the <strong>Code</strong> tab, look at the right sidebar</li>
<li>You should see a section labeled “About” with repo information</li>
<li>Write down what you see there</li>
</ol>
<hr />
<p><strong>Your evidence</strong> (fill in when closing this issue):</p>
<pre class="text"><code>1. I found ___ files in the root of the repository.
2. The open issue I found was titled "___".
3. The first paragraph of welcome.md says...
4. The repository description is...
5. The README says this workshop is for...
6. The About section shows...</code></pre>
<hr />
<h4 id="peer-simulation-check">Peer simulation check</h4>
<p>After you submit your evidence, open the <strong>Peer Simulation:
Welcome Link Needs Context</strong> issue in this repository and leave
an encouraging comment or reaction. If your facilitator gave you access
to a real buddy repository, you may use your buddy’s issue instead.</p>
<h4 id="if-you-get-stuck">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>I cannot find the tabs</td>
<td>Look for a horizontal navigation bar below the repository name.
Screen reader users: navigate by heading level 2 or use the landmark
navigation.</td>
</tr>
<tr>
<td>I cannot find <code>docs/welcome.md</code></td>
<td>On the Code tab, look for a folder called <code>docs</code>. Select
it, then select <code>welcome.md</code>.</td>
</tr>
<tr>
<td>I am not sure what counts as evidence</td>
<td>Any description of what you found works. There are no wrong answers
in a scavenger hunt.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-01-scavenger-hunt.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-2-file-your-first-issue">Challenge 2: File Your First
Issue</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-02-first-issue.yml">challenge-02-first-issue.yml</a></p>
<p><strong>Chapter:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/05-working-with-issues.md">Ch05:
Working with Issues</a></p>
<p><strong>What you will do:</strong> Find a TODO comment in
<code>docs/welcome.md</code>, then file an issue describing the problem
with a clear title and description.</p>
<h4 id="instructions">Instructions</h4>
<ol type="1">
<li>Open <code>docs/welcome.md</code> and look for a line that contains
<code>TODO</code> – this marks something that needs fixing.</li>
<li>Go to the <strong>Issues</strong> tab and select <strong>New
issue</strong>.</li>
<li>Write a clear, descriptive title (not just “Fix TODO”).</li>
<li>In the description, use this required format: - <code>What:</code>
what needs to change - <code>Where:</code> where the problem is (must
include <code>docs/welcome.md</code>) - <code>Why:</code> why the change
matters - Mention the exact <code>TODO</code> text you found</li>
</ol>
<p>### Required format (checked automatically)</p>
<p>Use this structure in your issue description:</p>
<pre class="text"><code>What: Replace the placeholder TODO with real welcome text.
Where: docs/welcome.md, intro section.
Why: New contributors need clear context when they open the file.
TODO found: TODO: Add a short workshop welcome paragraph.
```text
#### What makes a good issue title?
| Instead of this | Write this |
|---|---|
| Fix TODO | Fix missing workshop description in welcome.md |
| Bug | welcome.md TODO placeholder needs real content |
| Update file | Replace TODO in welcome.md intro section with actual welcome text |
---
**Your evidence** (fill in when closing this issue):
```text
Issue URL: https://github.com/...
I found a TODO in docs/welcome.md that said...
My issue title was...</code></pre>
<hr />
<h4 id="peer-simulation-check-1">Peer simulation check</h4>
<p>Open the <strong>Peer Simulation: Welcome Link Needs Context</strong>
issue and leave a comment: Is the title clear? Would you know what needs
fixing just from reading the title? If your facilitator gave you access
to a real buddy repository, you may review your buddy’s issue
instead.</p>
<h4 id="if-you-get-stuck-1">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>I cannot find the TODO</td>
<td>Open <code>docs/welcome.md</code> and use your browser’s find
feature (Ctrl+F or Cmd+F) to search for “TODO”.</td>
</tr>
<tr>
<td>I am not sure what to write in the description</td>
<td>Describe the problem as if you are explaining it to someone who has
never seen the file.</td>
</tr>
<tr>
<td>The New issue button is not visible</td>
<td>Make sure you are on the Issues tab. If issues are disabled, ask
your facilitator.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-02-first-issue.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-3-join-the-conversation">Challenge 3: Join the
Conversation</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-03-conversation.yml">challenge-03-conversation.yml</a></p>
<p><strong>Chapter:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/05-working-with-issues.md">Ch05:
Working with Issues</a></p>
<p><strong>What you will do:</strong> Practice GitHub’s collaboration
features by commenting on a peer-simulation issue, using <span
class="citation" data-cites="mentions">@mentions</span>, and adding
reactions.</p>
<h4 id="instructions-1">Instructions</h4>
<ol type="1">
<li>Open the <strong>Peer Simulation: Welcome Link Needs
Context</strong> issue in this repository. If your facilitator gave you
access to a real buddy repository, you may use your buddy’s Challenge 2
issue instead.</li>
<li>Leave a <strong>meaningful comment</strong> on their issue. Ideas:
<ul>
<li>Confirm you can reproduce the problem they described</li>
<li>Suggest an approach to fix it</li>
<li>Ask a clarifying question</li>
</ul></li>
<li>Use an <strong><span class="citation"
data-cites="mention">@mention</span></strong> in your comment. For the
simulation, mention <code>@gandalf-bot</code>. For a real buddy
repository, mention your buddy’s username.</li>
<li>Add a reaction to the original issue.</li>
</ol>
<h4 id="good-commenting-tips">Good commenting tips</h4>
<ul>
<li>Be specific (“I found the same TODO on line 12” is better than “I
agree”)</li>
<li>Be encouraging (“Great find!” is always welcome)</li>
<li>Be constructive (suggest, do not just criticize)</li>
</ul>
<hr />
<p><strong>Your evidence</strong> (fill in when closing this issue):</p>
<pre class="text"><code>Comment URL: https://github.com/...
I commented on the peer-simulation issue about...
I used a reaction to...</code></pre>
<hr />
<h4 id="peer-simulation-check-2">Peer simulation check</h4>
<p>If your facilitator gave you a real buddy, check whether they
commented on your issue and reply. Otherwise, reply to Gandalf or to
your own peer-simulation comment with one follow-up thought.</p>
<h4 id="if-you-get-stuck-2">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>I cannot find the peer-simulation issue</td>
<td>Go to the Issues tab and filter by the <code>peer-simulation</code>
label. If you are using a real buddy repository, ask your facilitator
for the link.</td>
</tr>
<tr>
<td>The <span class="citation" data-cites="mention">@mention</span> is
not working</td>
<td>Make sure there is no space between the @ and the username. The
username must match exactly.</td>
</tr>
<tr>
<td>I do not know how to add a reaction</td>
<td>Look for a smiley face icon at the top-right of the issue comment.
Screen reader users: the button is labeled “Add reaction”.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-03-conversation.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-4-branch-out">Challenge 4: Branch Out</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-04-branch-out.yml">challenge-04-branch-out.yml</a></p>
<p><strong>Chapter:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/06-working-with-pull-requests.md">Ch06:
Working with Pull Requests</a></p>
<p><strong>What you will do:</strong> Create a personal branch named
<code>learn/YOUR-USERNAME</code> where you will make your Day 1
changes.</p>
<h4 id="instructions-2">Instructions</h4>
<ol type="1">
<li>Make sure you are on the <strong>Code</strong> tab of the
learning-room repository.</li>
<li>Find the branch dropdown (it shows “main” by default).</li>
<li>Type <code>learn/YOUR-USERNAME</code> (replace YOUR-USERNAME with
your actual GitHub username).</li>
<li>Select <strong>Create branch: learn/YOUR-USERNAME from
main</strong>.</li>
</ol>
<h4 id="branch-naming-convention">Branch naming convention</h4>
<p>Your branch name must follow this pattern: <code>learn/</code>
followed by your GitHub username. Examples:</p>
<ul>
<li><code>learn/octocat</code></li>
<li><code>learn/mona-lisa</code></li>
<li><code>learn/student42</code></li>
</ul>
<p>This naming convention helps facilitators and automation identify
your work.</p>
<hr />
<p><strong>Your evidence</strong> (fill in when closing this issue):</p>
<pre class="text"><code>My branch name: learn/myusername
I created it by...</code></pre>
<hr />
<h4 id="peer-simulation-check-3">Peer simulation check</h4>
<p>Open the peer-simulation PR and notice its branch name. If you have a
real buddy, ask whether they created their branch and help them find the
branch dropdown if they are stuck.</p>
<h4 id="if-you-get-stuck-3">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>I cannot find the branch dropdown</td>
<td>Look for a button that says “main” with a dropdown arrow, near the
top-left of the file list. Screen reader users: it is a button labeled
“Switch branches/tags”.</td>
</tr>
<tr>
<td>It says the branch already exists</td>
<td>If you already created it, you are done. Switch to it and confirm
your username is in the name.</td>
</tr>
<tr>
<td>I typed the name wrong</td>
<td>Create a new branch with the correct name. The old one will not
cause problems.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-04-branch-out.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-5-make-your-mark">Challenge 5: Make Your Mark</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-05-make-your-mark.yml">challenge-05-make-your-mark.yml</a></p>
<p><strong>Chapter:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/06-working-with-pull-requests.md">Ch06:
Working with Pull Requests</a></p>
<p><strong>What you will do:</strong> Edit <code>docs/welcome.md</code>
on your branch to fix the TODO you found in Challenge 2, then commit
with a meaningful message.</p>
<h4 id="instructions-3">Instructions</h4>
<ol type="1">
<li>Make sure you are on your <code>learn/YOUR-USERNAME</code> branch
(check the branch dropdown).</li>
<li>Navigate to <code>docs/welcome.md</code>.</li>
<li>Select the <strong>pencil icon</strong> (Edit this file) to open the
editor.</li>
<li>Find the TODO and replace it with real content.</li>
<li>Write a <strong>meaningful commit message</strong> that explains
what you changed and why.</li>
<li>Commit directly to your branch.</li>
</ol>
<h4 id="what-makes-a-good-commit-message">What makes a good commit
message?</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Instead of this</th>
<th>Write this</th>
</tr>
</thead>
<tbody>
<tr>
<td>Update welcome.md</td>
<td>Add workshop description to replace TODO in welcome.md</td>
</tr>
<tr>
<td>Fix stuff</td>
<td>Replace placeholder text with actual welcome message</td>
</tr>
<tr>
<td>changes</td>
<td>Add participant introduction section to welcome.md</td>
</tr>
</tbody>
</table>
<p>A good commit message answers: <strong>What</strong> did I change and
<strong>why</strong>?</p>
<hr />
<p><strong>Your evidence</strong> (fill in when closing this issue):</p>
<pre class="text"><code>Commit URL: https://github.com/...
My commit message was: "..."
I changed the TODO to say...</code></pre>
<hr />
<h4 id="peer-simulation-check-4">Peer simulation check</h4>
<p>Compare your commit message with the peer-simulation PR title and
commit message. Can you tell what changed just from reading it? If you
have a real buddy, compare with their commit message too.</p>
<h4 id="if-you-get-stuck-4">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>I am editing on main instead of my branch</td>
<td>Switch to your branch first using the branch dropdown, then edit the
file.</td>
</tr>
<tr>
<td>I cannot find the edit button</td>
<td>Look for a pencil icon near the top-right of the file view. Screen
reader users: the button is labeled “Edit this file”.</td>
</tr>
<tr>
<td>I accidentally committed to main</td>
<td>Ask your facilitator for help. This is fixable.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-05-make-your-mark.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-6-open-your-first-pull-request">Challenge 6: Open Your
First Pull Request</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-06-first-pr.yml">challenge-06-first-pr.yml</a></p>
<p><strong>Chapter:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/06-working-with-pull-requests.md">Ch06:
Working with Pull Requests</a></p>
<p><strong>What you will do:</strong> Open a pull request from your
<code>learn/YOUR-USERNAME</code> branch to <code>main</code>, connecting
it to the issue you filed in Challenge 2.</p>
<h4 id="instructions-4">Instructions</h4>
<ol type="1">
<li>Go to the <strong>Pull requests</strong> tab.</li>
<li>Select <strong>New pull request</strong>.</li>
<li>Set <strong>base</strong> to <code>main</code> and
<strong>compare</strong> to <code>learn/YOUR-USERNAME</code>.</li>
<li>Write a descriptive PR title.</li>
<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>
<li>Submit the pull request.</li>
</ol>
<h4 id="pr-description-template">PR description template</h4>
<p>Use this structure for your PR description:</p>
<pre class="text"><code>### What this PR does
[One sentence describing your change]
### Why
[One sentence explaining why this change is needed]
Closes #XX
```text
#### The magic of `Closes #XX`
When you write `Closes #12` in a PR description, GitHub automatically:
- Links the PR to issue #12
- Closes issue #12 when the PR is merged
This is one of GitHub's most powerful workflow features.
---
**Your evidence** (fill in when closing this issue):
```text
PR URL: https://github.com/...
My PR links to issue #...</code></pre>
<hr />
<h4 id="peer-simulation-check-5">Peer simulation check</h4>
<p>Find the <strong>Peer Simulation: Improve contribution
guidance</strong> PR and leave an encouraging comment. If you have
access to a real buddy’s PR, you may comment there too. You will do a
full code review in Day 2.</p>
<h4 id="if-you-get-stuck-5">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>I cannot find the New pull request button</td>
<td>Make sure you are on the Pull requests tab. The button is near the
top-right.</td>
</tr>
<tr>
<td>It says “There isn’t anything to compare”</td>
<td>Make sure your branch has at least one commit that differs from
main. Did you commit to the right branch?</td>
</tr>
<tr>
<td>I forgot to include <code>Closes #XX</code></td>
<td>Edit your PR description after creating it. Select the three-dot
menu or the Edit button on the description.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-06-first-pr.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-7-survive-a-merge-conflict">Challenge 7: Survive a
Merge Conflict</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-07-merge-conflict.yml">challenge-07-merge-conflict.yml</a></p>
<p><strong>Chapter:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/07-merge-conflicts.md">Ch07:
Merge Conflicts</a></p>
<p><strong>What you will do:</strong> Your facilitator will
intentionally trigger a merge conflict in your PR. You will resolve it
by identifying conflict markers, choosing the right content, and
cleaning up the markers.</p>
<p><strong>Why this matters:</strong> Merge conflicts happen in real
teamwork. Learning to resolve them calmly is a key professional
skill.</p>
<h4 id="understanding-conflict-markers">Understanding conflict
markers</h4>
<p>When Git cannot automatically merge code, it marks the problem with
special markers:</p>
<pre class="text"><code><<<<<<< HEAD
The version currently on main branch
=======
Your version from your branch
>>>>>>> learn/your-username
```text
**Your job:** Decide which version is right (or combine them), then **DELETE all three marker lines** (the `<<<<<<<`, `=======`, `>>>>>>>` lines). The final file should have NO markers and have actual, meaningful code.
#### Step-by-step resolution
#### Step 1: Look at your PR
1. Go to your **Pull requests** tab
2. Click on your PR
3. You should see a message: "Can't automatically merge" or "This branch has conflicts..."
4. Look for a button: **Resolve conflicts** (or "Resolve")
5. Click it
#### Step 2: Find the conflict markers
1. GitHub will show the file with conflict markers highlighted
2. Look for lines starting with `<<<<<<<`, `=======`, `>>>>>>>`
3. Read both versions carefully
#### Step 3: Choose your version
You have three options:
- Keep the **main branch** version (delete everything from `<<<<<<<` to `=======` inclusive, keep `=======` to `>>>>>>>`)
- Keep **your branch** version (keep `<<<<<<<` to `=======` exclusive, delete `=======` to `>>>>>>>`)
- **Combine both** (keep parts of both, delete all marker lines)
- Ask your facilitator which is correct
#### Step 4: Clean up
1. Delete the marker lines: `<<<<<<<`, `=======`, `>>>>>>>`
2. The final file should have NO conflict markers
3. The final file should have meaningful, correct code
#### Step 5: Mark as resolved
1. At the bottom, click **Mark as resolved**
2. Commit the resolution
3. Your PR should now be mergeable
**Autograded:** The autograder will check that no conflict markers remain in your file and that the file has meaningful content.
---
**Your evidence** (fill in when closing this issue):
```text
The conflict was in file: ...
I chose to keep: ...
I resolved it by: ...</code></pre>
<hr />
<h4 id="peer-simulation-check-6">Peer simulation check</h4>
<p>Compare your resolution with the facilitator’s conflict seed or with
a real buddy if you have access. It is OK if two valid resolutions keep
different wording.</p>
<h4 id="if-you-get-stuck-6">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>I do not see a conflict</td>
<td>Your facilitator may not have triggered it yet. Wait for their
signal.</td>
</tr>
<tr>
<td>I cannot find the Resolve conflicts button</td>
<td>Look in the PR conversation tab, near the merge section at the
bottom. Screen reader users: search for “Resolve conflicts” button.</td>
</tr>
<tr>
<td>I am not sure which content to keep</td>
<td>Read both versions. If both are valuable, combine them. If one is
clearly better, keep that one. There is no single right answer.</td>
</tr>
<tr>
<td>The autograder still reports conflict markers</td>
<td>Search the file for <code><<<<<<<</code>,
<code>=======</code>, and <code>>>>>>>></code>. All
three types must be completely removed.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-07-merge-conflict.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-8-the-culture-layer">Challenge 8: The Culture
Layer</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-08-culture.yml">challenge-08-culture.yml</a></p>
<p><strong>Chapter:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/08-open-source-culture.md">Ch08:
Open Source Culture</a></p>
<p><strong>What you will do:</strong> Reflect on what makes open source
welcoming, then practice triaging an issue by adding descriptive
labels.</p>
<p><strong>Why this matters:</strong> Open source is about people, not
just code. Labels help teams organize work and signal what needs
attention.</p>
<h4 id="step-by-step-instructions">Step-by-step instructions</h4>
<h4 id="step-1-reflect-on-community">Step 1: Reflect on community</h4>
<p>Think about your workshop experience today and answer 2-3 of these
questions (write 1-2 sentences for each): - What made you feel welcome
or supported today? - What moment taught you something new? - What would
make this community more inclusive? - How did a peer help you or learn
from you?</p>
<h4 id="step-2-find-an-issue-to-triage">Step 2: Find an issue to
triage</h4>
<ol type="1">
<li>Click the <strong>Issues</strong> tab</li>
<li>Look for the <strong>Peer Simulation: Welcome Link Needs
Context</strong> issue (or a real classmate’s issue if you have buddy
access)</li>
<li>Click to open it</li>
</ol>
<h4 id="step-3-add-a-label">Step 3: Add a label</h4>
<ol type="1">
<li>In the issue, look on the right side for a section labeled
<strong>Labels</strong></li>
<li>Click in that section</li>
<li>You will see a dropdown menu of available labels</li>
<li>Choose ONE label that describes this issue:
<ul>
<li><code>bug</code> – something is broken or not working</li>
<li><code>enhancement</code> – a suggestion for improvement</li>
<li><code>documentation</code> – about docs, help, or guidance</li>
<li><code>good first issue</code> – suitable for newcomers</li>
<li><code>question</code> – asking for clarification</li>
</ul></li>
<li>Click the label to apply it</li>
<li>The label will appear in the issue</li>
</ol>
<h4 id="step-4-leave-a-comment-optional">Step 4: Leave a comment
(optional)</h4>
<ol type="1">
<li>Scroll down to the comment box</li>
<li>Type a short message about why you chose that label:</li>
</ol>
<pre class="text"><code> I added the "documentation" label because this issue helps new contributors understand the welcome section.
```text
3. Click **Comment**
#### Step 5: Submit your evidence
1. In the form below, write:
- Your 2-3 reflection answers
- Which issue you triaged and what label you added
- Why you chose that label
---
**Your evidence** (fill in when closing this issue):
```text
Reflection: ...
I triaged issue #XX by adding the label "___".
I chose that label because...</code></pre>
<hr />
<h4 id="peer-simulation-check-7">Peer simulation check</h4>
<p>Share your reflection in the peer-simulation issue or with your buddy
if you have one. Different perspectives make the community richer.</p>
<h4 id="if-you-get-stuck-7">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>I do not see any labels</td>
<td>You may need to create them. On the Issues tab, look for the Labels
link (next to Milestones). Or ask your facilitator to set up default
labels.</td>
</tr>
<tr>
<td>I cannot add a label to someone else’s issue</td>
<td>You may need collaborator permissions. Ask your facilitator if
labels are not available.</td>
</tr>
<tr>
<td>I do not know what to reflect on</td>
<td>Start with the simplest question: “What is one thing I learned
today?” There are no wrong answers.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-08-culture.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-9-merge-day">Challenge 9: Merge Day</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-09-merge-day.yml">challenge-09-merge-day.yml</a></p>
<p><strong>Chapter:</strong> <a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/10-notifications-and-day-1-close.md">Ch10:
Notifications and Day 1 Close</a></p>
<p><strong>What you will do:</strong> Get your Day 1 PR merged, verify
your changes on main, and celebrate completing all Day 1 challenges.</p>
<p><strong>Why this matters:</strong> Merging is how work gets
integrated. This is the payoff for all your effort today.</p>
<h4 id="pre-merge-checklist">Pre-merge checklist</h4>
<p>Before clicking merge, make sure: - ✅ Your PR has no conflict
markers or merge conflicts (if it does, go back to Challenge 7) - ✅
Your PR description includes <code>Closes #XX</code> linking to your
Challenge 2 issue - ✅ Your commit message is meaningful (describes what
you changed) - ✅ You have reviewed your changes one last time</p>
<h4 id="step-by-step-merge">Step-by-step merge</h4>
<h4 id="step-1-open-your-pr">Step 1: Open your PR</h4>
<ol type="1">
<li>Click the <strong>Pull requests</strong> tab</li>
<li>Find your PR (the one you created in Challenge 6)</li>
<li>Click it to open</li>
</ol>
<h4 id="step-2-check-the-merge-button">Step 2: Check the merge
button</h4>
<ol type="1">
<li>Look at the top of the PR</li>
<li>You should see a button labeled <strong>Merge pull request</strong>
in green</li>
<li>If the button is gray and disabled, your facilitator may need to
approve it or resolve conflicts first</li>
<li>Ask your facilitator if needed</li>
</ol>
<h4 id="step-3-click-to-merge">Step 3: Click to merge</h4>
<ol type="1">
<li>Click the green <strong>Merge pull request</strong> button</li>
<li>A dropdown may appear with merge strategy options - just click
<strong>Merge</strong></li>
<li>You may see a confirmation message asking if you’re sure - click
<strong>Confirm merge</strong></li>
<li>GitHub will show “Pull request successfully merged”</li>
</ol>
<h4 id="step-4-verify-your-changes-are-on-main">Step 4: Verify your
changes are on main</h4>
<ol type="1">
<li>Click the <strong>Code</strong> tab</li>
<li>Make sure the branch dropdown shows <code>main</code></li>
<li>Navigate to <code>docs/welcome.md</code></li>
<li>You should see your new welcome text (not the TODO)</li>
<li>This confirms your change is now on the main branch for everyone to
see</li>
</ol>
<h4 id="step-5-check-that-your-issue-was-closed">Step 5: Check that your
issue was closed</h4>
<ol type="1">
<li>Click the <strong>Issues</strong> tab</li>
<li>Look at the issue you filed in Challenge 2</li>
<li>It should show <strong>Closed</strong> (because your PR said
<code>Closes #XX</code>)</li>
<li>This automation keeps issues and PRs connected</li>
</ol>
<h4 id="day-1-achievements">Day 1 achievements 🎉</h4>
<p>Stop and celebrate! You have now: - Navigated a real GitHub
repository - Filed an issue with clear, structured content -
Collaborated through comments and <span class="citation"
data-cites="mentions">@mentions</span> - Created a feature branch safely
- Made a meaningful commit with a good message - Opened a pull request
linking to your work - Resolved a merge conflict under pressure -
Reflected on community and open source culture - <strong>Merged code
that is now part of the main repository</strong></p>
<p>That is the full professional GitHub workflow. You just did it!</p>
<h4 id="day-1-celebration">Day 1 celebration</h4>
<p>You have completed Day 1. Take a moment to appreciate what you
accomplished: - You navigated a real GitHub repository - You filed an
issue and had a conversation - You created a branch, made changes, and
opened a pull request - You survived a merge conflict - You contributed
to an open source community</p>
<hr />
<p><strong>Your evidence</strong> (fill in when closing this issue):</p>
<pre class="text"><code>My PR was merged: [link]
My issue was automatically closed: [link]
One thing I am proud of from Day 1: ...</code></pre>
<hr />
<h4 id="peer-simulation-check-8">Peer simulation check</h4>
<p>Leave a wrap-up comment on the peer-simulation issue or PR. If you
have real buddy access, congratulate your buddy on completing Day 1.</p>
<h4 id="if-you-get-stuck-8">If you get stuck</h4>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr>
<th>Symptom</th>
<th>Try this</th>
</tr>
</thead>
<tbody>
<tr>
<td>My PR still has conflicts</td>
<td>Go back to Challenge 7 and resolve them first.</td>
</tr>
<tr>
<td>The merge button is disabled</td>
<td>Your facilitator may need to approve the merge, or branch protection
rules may require a review. Ask your facilitator.</td>
</tr>
<tr>
<td>My issue did not close automatically</td>
<td>Check that your PR description contains <code>Closes #XX</code> with
the correct issue number. You can edit the PR description and re-merge
if needed.</td>
</tr>
<tr>
<td>I finished but want to check my work</td>
<td><a
href="https://github.com/Community-Access/git-going-with-github/blob/main/docs/solutions/solution-09-merge-day.md">View
the reference solution</a></td>
</tr>
</tbody>
</table>
<hr />
<h3 id="challenge-10-go-local">Challenge 10: Go Local</h3>
<p>Source template: <a
href="learning-room/.github/ISSUE_TEMPLATE/challenge-10-go-local.yml">challenge-10-go-local.yml</a></p>
<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>
<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>
<h4 id="the-local-workflow">The local workflow</h4>
<p>This is the professional Git workflow you will use for the rest of
your career:</p>
<ol type="1">
<li><strong>Clone</strong> the repository to your computer</li>
<li><strong>Branch</strong> – create a new branch for your work</li>
<li><strong>Edit</strong> – make your changes in your local editor</li>
<li><strong>Commit</strong> – save a snapshot locally with a
message</li>
<li><strong>Push</strong> – send your branch to GitHub</li>
</ol>
<h4 id="choose-your-tool-and-follow-the-steps">Choose your tool and
follow the steps</h4>
<h4 id="option-a-vs-code-recommended-for-day-2">Option A: VS Code
(recommended for Day 2)</h4>
<h4 id="step-1-clone-the-repository">Step 1: Clone the repository</h4>
<ol type="1">
<li>Open VS Code</li>
<li>Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the Command
Palette</li>
<li>Type <code>Git: Clone</code></li>
<li>Paste this repository URL:
<code>https://github.com/Community-Access/vscode-sci-fi-themes.git</code></li>
<li>Choose a folder on your computer where you want to save it</li>
<li>Wait for it to clone (you should see it in the file explorer)</li>
</ol>
<h4 id="step-2-create-your-feature-branch">Step 2: Create your feature
branch</h4>
<ol type="1">
<li>Press Ctrl+Shift+P again</li>
<li>Type <code>Git: Create Branch</code></li>
<li>Name it: <code>fix/YOUR-USERNAME</code> (replace YOUR-USERNAME with
your username)</li>
<li>Press Enter</li>
</ol>
<h4 id="step-3-edit-a-file">Step 3: Edit a file</h4>
<ol type="1">
<li>In the explorer on the left, open <code>README.md</code></li>
<li>Add a comment, fix a typo, or improve a sentence (just 1-2
lines)</li>
</ol>
<h4 id="step-4-commit-your-change">Step 4: Commit your change</h4>
<ol type="1">
<li>Press Ctrl+Shift+G to open the Source Control panel</li>
<li>You will see your modified file listed</li>
<li>Select the <strong>+</strong> next to it to <strong>Stage</strong>
the change</li>
<li>In the message field at the top, write a commit message:</li>
</ol>
<pre class="text"><code> docs: improve README wording
```text
5. Press Ctrl+Enter (or select the checkmark) to **Commit**
#### Step 5: Push to GitHub
1. Press Ctrl+Shift+P again
2. Type `Git: Push`
3. You may see a prompt asking about "set upstream" - select **OK**
4. Wait for the push to complete
---
#### Option B: GitHub Desktop
#### Step 1: Clone the repository
1. Open GitHub Desktop
2. Choose File > Clone Repository
3. Paste the URL: `https://github.com/Community-Access/vscode-sci-fi-themes.git`
4. Choose a folder location
5. Select Clone
#### Step 2: Create your feature branch
1. Open the **Branch** menu at the top
2. Select **New Branch**
3. Name it: `fix/YOUR-USERNAME`