Skip to content

solution 02 first issue

github-actions[bot] edited this page May 5, 2026 · 1 revision

Solution Reference: Challenge 2 -- File Your First Issue

This shows two example issues. Yours will look different and that is fine.

Example 1: Bug report style

Title: TODO in welcome.md: missing workshop schedule link

Body:

In docs/welcome.md, line 15, there is a TODO comment that says "add link to workshop schedule." This placeholder should be replaced with an actual link so students can find the schedule.

Steps to find it:

  1. Open docs/welcome.md
  2. Search for "TODO"
  3. The comment is on line 15

Example 2: Feature request style

Title: Add accessibility tips section to welcome.md

Body:

The welcome document covers what students will do but does not mention accessibility features. A short section pointing students to screen reader shortcuts and keyboard navigation would help everyone start on equal footing.

Suggested location: After the "What you will learn" section.

What makes a good issue

  • Clear title: Someone scanning the issue list can understand the topic without opening it
  • Enough context: Another person could find and understand the problem from your description alone
  • Reproducible location: File name and line number (if relevant) so the fix is easy to find

Alternate approaches

Both bug reports and feature suggestions are valid for this challenge. The key is writing clearly enough that a stranger could act on your issue.

Clone this wiki locally