rajatsainju2025/code-explainer

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

Open

#8 opened on Aug 8, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (0 forks)auto 404
cigood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Examine the existing CI configuration (e.g., .github/workflows/) and the Colab quickstart notebook. Add a new job that uses nbval or papermill to execute the notebook, ensuring it runs on pushes to main or pull requests. Skip for forks using a condition.
Tech stack
python
Domain
ci cdtesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75