You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f8b599c
Browse filesBrowse the repository at this point in the historyBrowse files
**What you will do:** Choose an existing agent in the accessibility-agents repository, identify something that could be better, and open a PR with your improvement.
15
+
16
+
### Instructions
17
+
18
+
1. Browse the agents in the [accessibility-agents repository](https://github.com/Community-Access/accessibility-agents).
19
+
2. Pick one that interests you and read its `.agent.md` file carefully.
20
+
3. Identify an improvement. Ideas:
21
+
- Add a missing guardrail
22
+
- Clarify a responsibility that is vague
23
+
- Fix a typo or improve the description
24
+
- Add a new responsibility that fits the agent's purpose
25
+
4. Make the change on your fork (you already forked this in Challenge 16).
26
+
5. Open a pull request explaining what you improved and why.
**What you will do:** Explore this learning-room repository like a scavenger hunt. You will navigate tabs, the file tree, read key files, and find landmarks.
14
+
**What you will do:** Explore the learning-room repository like a scavenger hunt. Find the tabs, navigate the file tree, read the README, and locate key files.
15
15
16
-
### Step-by-step scavenger hunt
16
+
### Scavenger hunt checklist
17
17
18
-
**Task 1: Count files in the root**
19
-
1. Make sure you are on the **Code** tab (select it at the top)
20
-
2. Look at the file/folder list
21
-
3. Count how many items are showing (stop before the first folder)
22
-
4. Write down this number
18
+
Work through each item. You do not need to complete them in order.
23
19
24
-
**Task 2: Find an open issue**
25
-
1. Select the **Issues** tab
26
-
2. Look for issues with an **Open** label
27
-
3. Open one to read it
28
-
4. Write down its title
29
-
30
-
**Task 3: Read welcome.md**
31
-
1. Select the **Code** tab
32
-
2. Look for a folder named `docs/`
33
-
3. Open it
34
-
4. Find `welcome.md` and select it
35
-
5. Read the first paragraph (the opening sentence)
36
-
6. Write down what it says
37
-
38
-
**Task 4: Find the repo description**
39
-
1. Go to the **Code** tab
40
-
2. Look at the top-right area - you should see a text description under the repo name
41
-
3. This is the "About" section
42
-
4. Write down what it says
43
-
44
-
**Task 5: Read the README**
45
-
1. On the **Code** tab, scroll down to find `README.md`
46
-
2. Select it to open
47
-
3. Find the section that says "Who this workshop is for"
48
-
4. Write down the answer
49
-
50
-
**Task 6: Check the About section**
51
-
1. On the **Code** tab, look at the right sidebar
52
-
2. You should see a section labeled "About" with repo information
53
-
3. Write down what you see there
20
+
- [ ] Find the **Code** tab and count how many files are in the root of the repository
21
+
- [ ] Open the **Issues** tab and find an open issue
22
+
- [ ] Navigate to `docs/welcome.md` and read the first paragraph
23
+
- [ ] Find the repository description (hint: it is near the top of the Code tab)
24
+
- [ ] Locate the `README.md` file and identify who this workshop is for
25
+
- [ ] Find the **Settings** information area (About section) on the right side of the Code tab
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/challenge-02-first-issue.yml
+24-49Lines changed: 24 additions & 49 deletions
Original file line number
Diff line number
Diff line change
@@ -10,62 +10,37 @@ body:
10
10
11
11
**Chapter:** [Ch05: Working with Issues](https://github.com/Community-Access/git-going-with-github/blob/main/docs/05-working-with-issues.md)
12
12
13
-
**What you will do:** Find a TODO comment in `docs/welcome.md`, then file an issue describing the problem with a clear, specific title and a well-structured description.
13
+
**What you will do:** Find a TODO comment in `docs/welcome.md`, then file an issue describing the problem with a cleartitle and description.
14
14
15
-
### Step-by-step instructions
15
+
### Instructions
16
16
17
-
#### Step 1: Find the TODO
18
-
1. Open `docs/welcome.md` in this repository
19
-
2. Look for a line containing the word `TODO`
20
-
3. Copy the exact text of the TODO (the whole line, including the word TODO)
21
-
4. Note the section where it appears
17
+
1. Open `docs/welcome.md` and look for a line that contains `TODO` -- this marks something that needs fixing.
18
+
2. Go to the **Issues** tab and select **New issue**.
19
+
3. Write a clear, descriptive title (not just "Fix TODO").
20
+
4. In the description, use this required format:
21
+
- `What:` what needs to change
22
+
- `Where:` where the problem is (must include `docs/welcome.md`)
23
+
- `Why:` why the change matters
24
+
- Mention the exact `TODO` text you found
22
25
23
-
#### Step 2: Create a new issue
24
-
1. Go to the **Issues** tab at the top of the repository
25
-
2. Select the **New issue** button
26
-
3. You will see this template. Fill it out as described below.
26
+
### Required format (checked automatically)
27
27
28
-
#### Step 3: Write the issue title
29
-
**PUT THIS TEXT IN THE TITLE FIELD:**
28
+
Use this structure in your issue description:
30
29
31
-
```
32
-
Replace TODO in docs/welcome.md with actual welcome text
33
-
```
30
+
```text
31
+
What: Replace the placeholder TODO with real welcome text.
32
+
Where: docs/welcome.md, intro section.
33
+
Why: New contributors need clear context when they open the file.
34
+
TODO found: TODO: Add a short workshop welcome paragraph.
35
+
```
34
36
35
-
The title should:
36
-
- Be **specific** (not just "Fix TODO" or "Bug")
37
-
- Say **what file** has the problem (docs/welcome.md)
38
-
- Say **what needs to happen** (replace, add, update, etc.)
37
+
### What makes a good issue title?
39
38
40
-
❌ **Bad titles:**
41
-
- "Fix TODO"
42
-
- "Bug in welcome.md"
43
-
- "Update file"
44
-
45
-
✅ **Good titles:**
46
-
- "Replace TODO in docs/welcome.md with actual welcome text"
47
-
- "Add missing welcome description to docs/welcome.md"
48
-
- "Remove placeholder TODO from welcome.md intro"
49
-
50
-
#### Step 4: Write the issue description
51
-
**PUT THIS TEXT IN THE DESCRIPTION FIELD:**
52
-
53
-
Copy this format **exactly** and fill in your answers:
54
-
55
-
```
56
-
What: Replace the placeholder TODO with real welcome text for new contributors.
57
-
Where: docs/welcome.md, in the intro section.
58
-
Why: New contributors need clear context immediately when they open the file.
59
-
TODO found: TODO: Add a short workshop welcome paragraph.
60
-
```
61
-
62
-
**Line-by-line breakdown:**
63
-
- **What:** Describe what change needs to happen
64
-
- **Where:** Name the file and section where the problem is (MUST say `docs/welcome.md`)
65
-
- **Why:** Explain why this change matters to users or contributors
66
-
- **TODO found:** Paste the exact TODO text you found in the file
67
-
68
-
This format is **checked automatically** by our grading bot. If any line is missing, it will ask you to revise.
39
+
| Instead of this | Write this |
40
+
|---|---|
41
+
| Fix TODO | Fix missing workshop description in welcome.md |
42
+
| Bug | welcome.md TODO placeholder needs real content |
43
+
| Update file | Replace TODO in welcome.md intro section with actual welcome text |
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/challenge-03-conversation.yml
+14-53Lines changed: 14 additions & 53 deletions
Original file line number
Diff line number
Diff line change
@@ -11,62 +11,23 @@ body:
11
11
12
12
**Chapter:** [Ch05: Working with Issues](https://github.com/Community-Access/git-going-with-github/blob/main/docs/05-working-with-issues.md)
13
13
14
-
**What you will do:** Practice GitHub collaboration by commenting on an issue, using @mentions to tag someone, and adding a reaction.
14
+
**What you will do:** Practice GitHub's collaboration features by commenting on a peer-simulation issue, using @mentions, and adding reactions.
15
15
16
-
### Step-by-step instructions
16
+
### Instructions
17
17
18
-
#### Step 1: Find the peer-simulation issue
19
-
1. Go to the **Issues** tab in this repository
20
-
2. Look for an issue titled **"Peer Simulation: Welcome Link Needs Context"**
21
-
3. Open it
22
-
23
-
**Alternative:** If your facilitator gave you access to a real buddy repository, you can comment on your buddy's Challenge 2 issue instead.
18
+
1. Open the **Peer Simulation: Welcome Link Needs Context** 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.
19
+
2. Leave a **meaningful comment** on their issue. Ideas:
20
+
- Confirm you can reproduce the problem they described
21
+
- Suggest an approach to fix it
22
+
- Ask a clarifying question
23
+
3. Use an **@mention** in your comment. For the simulation, mention `@gandalf-bot`. For a real buddy repository, mention your buddy's username.
24
+
4. Add a reaction to the original issue.
24
25
25
-
#### Step 2: Write a comment on the issue
26
-
1. Scroll to the bottom of the issue
27
-
2. In the text field labeled "Leave a comment", place your cursor and start typing
28
-
3. Write a **meaningful comment**. Examples of what to say:
29
-
- "I see the same TODO on line 12. The welcome section really needs actual content."
30
-
- "Great catch! This TODO is in docs/welcome.md where new people look first."
31
-
- "How should we fill this in? Should it be welcoming text or instructional?"
26
+
### Good commenting tips
32
27
33
-
**Your comment MUST:**
34
-
- Be more than just "I agree" or "Good job" (be specific and helpful)
35
-
- Include an **@mention** (see Step 3 below)
36
-
- Be at least 2-3 sentences
37
-
38
-
#### Step 3: Use an @mention in your comment
39
-
**IN THE COMMENT YOU JUST WROTE**, add this line:
40
-
41
-
```
42
-
Hey @gandalf-bot, what do you think about this TODO?
43
-
```
44
-
45
-
OR if you are commenting on a real buddy's issue, use their username:
46
-
```
47
-
Hey @buddy-username, what do you think about this TODO?
48
-
```
49
-
50
-
**Key points:**
51
-
- Type `@` followed immediately by the name (no space)
52
-
- The name must match exactly
53
-
- The person/bot will be notified when you mention them
54
-
55
-
#### Step 4: Add a reaction
56
-
1. Look at the top-right of the original issue (the one you're commenting on)
57
-
2. Find the reaction button labeled "Add your reaction"
58
-
3. Open it and choose a reaction (😀, 👍, ❤️, etc.)
59
-
4. This shows the issue author you care about their work
60
-
61
-
#### Step 5: Submit your evidence
62
-
1. Scroll down to "Your evidence" section in this form
63
-
2. Paste the **URL of the comment you just left**
64
-
- Go back to the issue you commented on
65
-
- Find your comment
66
-
- Open the comment timestamp menu (e.g., "just now" or "2 minutes ago")
67
-
- Select "Copy link"
68
-
- Paste it into the evidence field
69
-
3. Answer: "What was helpful or interesting about the comment you left?"
28
+
- Be specific ("I found the same TODO on line 12" is better than "I agree")
29
+
- Be encouraging ("Great find!" is always welcome)
30
+
- Be constructive (suggest, do not just criticize)
70
31
71
32
- type: textarea
72
33
id: evidence
@@ -94,5 +55,5 @@ hidden: true
94
55
|---|---|
95
56
| I cannot find the peer-simulation issue | Go to the Issues tab and filter by the `peer-simulation` label. If you are using a real buddy repository, ask your facilitator for the link. |
96
57
| The @mention is not working | Make sure there is no space between the @ and the username. The username must match exactly. |
97
-
| I do not know how to add a reaction | Look for the reaction button at the top-right of the issue comment. Screen reader users: the button is labeled "Add reaction". |
58
+
| I do not know how to add a reaction | Look for a smiley face icon at the top-right of the issue comment. Screen reader users: the button is labeled "Add reaction". |
98
59
| 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-03-conversation.md) |
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/challenge-04-branch-out.yml
+12-31Lines changed: 12 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -11,43 +11,24 @@ body:
11
11
12
12
**Chapter:** [Ch06: Working with Pull Requests](https://github.com/Community-Access/git-going-with-github/blob/main/docs/06-working-with-pull-requests.md)
13
13
14
-
**What you will do:** Create a personal branch named `learn/YOUR-USERNAME` where you will do your Day 1 work.
14
+
**What you will do:** Create a personal branch named `learn/YOUR-USERNAME` where you will make your Day 1 changes.
15
15
16
-
**Why branches matter:** Branches let you work safely without affecting the main codebase. Each person gets their own "sandbox."
16
+
### Instructions
17
17
18
-
### Step-by-step instructions
18
+
1. Make sure you are on the **Code** tab of the learning-room repository.
19
+
2. Find the branch dropdown (it shows "main" by default).
20
+
3. Type `learn/YOUR-USERNAME` (replace YOUR-USERNAME with your actual GitHub username).
21
+
4. Select **Create branch: learn/YOUR-USERNAME from main**.
19
22
20
-
#### Step 1: Go to the Code tab
21
-
1. Select the **Code** tab at the top of the learning-room repository
22
-
2. You should see a list of files and folders
23
+
### Branch naming convention
23
24
24
-
#### Step 2: Find the branch dropdown
25
-
1. Look for a button that says **"main"** (usually appears above the file list)
26
-
2. This is the branch dropdown
27
-
3. Open it
25
+
Your branch name must follow this pattern: `learn/` followed by your GitHub username. Examples:
28
26
29
-
#### Step 3: Create your branch
30
-
1. In the text field that appears, type your branch name: `learn/YOUR-USERNAME`
31
-
- Replace `YOUR-USERNAME` with your actual GitHub username (the one you use to log in)
0 commit comments