Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[curriculum-eval] side-quest-01-02-environment-reference.md: checkpoint_quality — checkpoint invisible to rubric due to shortcode heading mismatch

Closed Beginner friendly
#3,980 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
markdown, python

Research direction

Start in .github/skills/curriculum-quantitative-assessment/curriculum_assessment.py by reading CHECKPOINT_RE and related checkpoint detection logic. Update recognition for the ✅ heading format, then rerun the curriculum rubric against the workshop corpus and verify valid checkpoint sections no longer receive a zero checkpoint_quality score. The separate workshop content suggestions are optional follow-up scope.

Written by the indexing model from the issue text.

Description

curriculum documentation quality

File: workshop/side-quest-01-02-environment-reference.md
Overall Score: 4.93 / 10.0 (corpus mean: 6.09 / 10.0)

Flagged Dimensions:

Dimension Score Benchmark Delta
checkpoint_quality 0.0 ≥ 4 items → ≥10 (has_checkpoint required) −10.0
active_learning 2.1 ≥ 3.0 density (10.0 cap) −0.9
cognitive_load 6.3 ≤ 800 words (10.0) −3.7

Root Cause (≤ 2 sentences):
The rubric's CHECKPOINT_RE only matches a literal ✅ emoji heading (## ✅ Checkpoint), but this file (like 90 of 93 workshop files) uses the :white_check_mark: shortcode instead, so has_checkpoint evaluates to False and checkpoint_quality is forced to 0.0 even though the page has a real, well-formed checkpoint with 7 checklist items. Separately, at 1,433 words this reference page is nearly double the 800-word cognitive-load ceiling and its 0.63 activity density (2 code blocks + 7 checklist items per ~1,430 words) is far below the ideal density of 3.

Evidence (quoted from the file):

✅ Checkpoint

  • You can name each environment and tool used in this workshop and describe its role

Learning Science Rationale:
Mayer's Signaling Principle holds that clear, consistently recognized structural cues (like a checkpoint heading) help learners self-assess progress; a checkpoint that exists in the markdown but is invisible to the scoring tool represents a measurement gap, not a content gap, and should be fixed at the rubric level, not by rewriting a correct heading. Independently, Sweller's Cognitive Load Theory predicts that a 1,433-word single-pass reference page with low activity density forces learners into passive reading rather than active retrieval, increasing extraneous load and reducing retention — the page would benefit from being split or from adding retrieval-practice checkboxes throughout, not just at the end.

Improvement Prompt (for an agent):

In .github/skills/curriculum-quantitative-assessment/curriculum_assessment.py, update CHECKPOINT_RE (and any related prereq/checkpoint detection regex) to also match the ":white_check_mark:" shortcode heading format used across the workshop (e.g. "## :white_check_mark: Checkpoint"), in addition to the literal "✅" emoji. Re-run the rubric against the workshop corpus and confirm checkpoint_quality scores are no longer zero for files that have a valid checkpoint section. Separately, in workshop/side-quest-01-02-environment-reference.md, consider adding 2-3 short "quick check" checklist items or mini code snippets distributed through the glossary and screenshot sections (not just at the end) to raise activity_density above 3, and evaluate whether the glossary table and the conceptual-screenshots section could be split into two shorter pages to bring word_count under 800.

Expected Score After Fix: 7.0 / 10.0 (assuming rubric regex fix restores checkpoint_quality to ~10 and activity density improves modestly)

Generated by 🔬 Curriculum Quality Evaluator · copilot · auto · 125.2 AIC · ⌖ 7.43 AIC · ⊞ 9K · ◷

  • expires on Sep 30, 2026, 1:09 PM UTC
Dominant language
JavaScript
Stars
51
Forks
23
Avg merge
8h 30m
Merged PRs (30d)
21

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • No Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from githubnext/gh-aw-workshop

All issues in githubnext/gh-aw-workshop

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.