[curriculum-eval] curriculum_assessment.py: checkpoint_quality — detector misses ":white_check_mark: Checkpoint" and ":clipboard: Before You Start

Ouverte Adaptée aux débutants
#5,745 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
python
Domaine
tooling

Piste de recherche

Ouvre .github/skills/curriculum-quantitative-assessment/curriculum_assessment.py et regarde CHECKPOINT_RE ainsi que la fonction qui définit has_prereq_section ; les deux ne correspondent actuellement qu'à un titre emoji littéral. Élargis les motifs pour accepter les variantes shortcode et emoji listées dans l'issue, puis vérifie si le module a déjà un fichier de test à étendre, et ajoute des cas pour chaque forme de titre. Terminé ressemble à des tests unitaires qui passent et une réexécution sur workshop/ rapportant has_checkpoint: true pour 93+ pages, sans contenu du workshop modifié.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

curriculum documentation quality

File: .github/skills/curriculum-quantitative-assessment/curriculum_assessment.py
Overall Score: n/a (affects 93/95 pages; corpus mean 6.06)

Flagged Dimensions:

Dimension Score Benchmark Delta
checkpoint_quality 0.0 on 93 pages ≥ 4 items → 10 −10
scaffolding 5.0 on 95 pages section present → 10 −5

Root Cause (≤ 2 sentences):
CHECKPOINT_RE = r"##\s+✅\s*Checkpoint" requires the literal emoji, but workshop pages use the GitHub shortcode ## :white_check_mark: Checkpoint; likewise has_prereq_section is false for every page despite ## :clipboard: Before You Start. Only 2 pages (side-quest-13-01, side-quest-13-02) use the literal emoji, which is why they top the ranking at 8.4–8.6.

Evidence (quoted from the file):

CHECKPOINT_RE = re.compile(r"##\s+✅\s*Checkpoint", re.IGNORECASE)

(e.g. workshop/04-github-actions-intro.md: ## :white_check_mark: Checkpoint followed by 5 checklist items, yet has_checkpoint: false)

Learning Science Rationale:
Valid measurement underpins any evidence-based evaluation: a rubric that scores a present formative-assessment checkpoint as zero misdirects improvement effort (Goodhart's law) and hides real gaps such as cognitive overload (Sweller) and low activity density behind a uniform ~2.75-point penalty.

Improvement Prompt (for an agent):

In .github/skills/curriculum-quantitative-assessment/curriculum_assessment.py, update CHECKPOINT_RE to match "## :white_check_mark: Checkpoint", "## ✅ Checkpoint" and "## ✅Checkpoint" (e.g. r"##\s+(?:✅|:white_check_mark:)\s*Checkpoint"). Also update the prerequisite/scaffolding detection so headings like "## :clipboard: Before You Start", "## 📋 Before You Start" and "Prerequisites" all count. Add unit tests for each heading variant, rerun the assessment over workshop/, and confirm 93+ pages now report has_checkpoint=true. Do not edit workshop content.

Expected Score After Fix: ~8.6 / 10.0 corpus mean (≈ +2.5 per page; measurement fix only)

Generated by 🔬 Curriculum Quality Evaluator · copilot · auto · ~40 AIC · ⌖ ~1 AIC · ⊞ 5K · ◷

  • expires on Nov 16, 2026, 5:04 AM UTC
Langage dominant
JavaScript
Étoiles
62
Forks
43
Merge moyen
11 h 26 min
PR mergées (30 j)
13

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

  • Aucun Dockerfile ni fichier Docker Compose
  • Aucun modèle de pull request
  • Aucun guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de githubnext/gh-aw-workshop

Toutes les issues de githubnext/gh-aw-workshop

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.