rajatsainju2025/code-explainer

ci: Add Colab notebook test in CI (nbval or papermill)

Offen

#8 geöffnet am 08.08.2025

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (0 Forks)auto 404
cigood first issue

Repository-Metriken

Stars
 (1 Stern)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Add a CI job that runs the Colab quickstart notebook (executed via nbval or papermill) to ensure examples stay valid. Skip on forks. Reference examples/README.md.

Labels: good first issue, ci

Contributor Guide

Research-Richtung
Überprüfe die vorhandene CI Konfiguration (z. B. .github/workflows/) und das Colab Quickstart Notebook. Füge einen neuen Job hinzu, der das Notebook mit nbval oder papermill ausführt, und stelle sicher, dass er bei Pushes auf main oder Pull Requests ausgeführt wird. Überspringe Forks mit einer Bedingung.
Tech Stack
python
Domain
ci cdtesting
Issue Type
Test
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75