review-exercise

name	review-exercise
description	Review a GitHub Skills exercise for format, clarity, learner flow, and workflow correctness. Use when asked to review an exercise draft, inspect step content, or find issues before publishing.

Review Exercise Format and Quality

Review an existing GitHub Skills exercise, check the following things to ensure it is high quality.

General

• Test that all images can be retrieved.
• Test that all links are working.

Readme

• The introduction is not introducing any new material. It is only a brief overview.
• The url for the start exercise button is correct.
• The overview area matches what's taught in the learning steps.
• The prerequisites are relevant.

Step - Content files

• The theory sections are digestible and not too long.
• Activity steps are numbered correctly. Nothing like images or alerts breaks the numbering.
• Check for typos and confusing wording.

Step - Workflow files

• Verify all variables match the markdown templates being used.
• Step 0 is does not need to be manually disabled. The start exercise workflow disables all workflows.
• Check for typos.

Review file

• The overview area matches what's taught in the learning steps.
• The resources are relevant.
• The "What's next?" section is relevant.

Final sanity check

Assume the role of a learner. Read through each step one at a time and imagine how you would complete the exercise. The goal is to identify points that would cause a learner to give up.

• If something seems illogical, make a note..
• If you don't understand something, make a note.
• If something could be misinterpreted, make a note.
• If you get stuck, make a note.