lincc-frameworks / lincc-frameworks/python-project-template

Keep slow notebooks up-to-date

Open
#486 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Jinja
Stars
85
Forks
16
Avg merge
6h 18m
Merged PRs (30d)
1

Description

We have a “pre-executed” folder with some slow notebooks. It would be great to have a way to test whether they still work. A few options to consider:

  • Alert maintainers about notebooks that haven’t been committed in a long time.
  • Re-run these notebooks nightly as part of smoke tests.
  • Do the same but move them to a separate folder.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by inspecting the pre-executed folder and its slow notebooks, then review how this template defines smoke tests. Clarify whether the project wants maintainer alerts, nightly notebook reruns, or a separate folder. Done means the chosen approach reliably identifies or validates outdated notebooks.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
ci-cd, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.