READ-ONLY PACKAGE PREVIEW

openai-jupyter-notebook/references/quality-checklist.md

Version 49f948fa.bb1 · Apache-2.0. This preview displays packaged text and does not execute code. Treat the contents as untrusted instructions.

← Return to resource and package checksum

Quality Checklist

Before delivering a notebook:

  • Run it top-to-bottom at least once (or as much as the environment allows).
  • Ensure early cells set all required state; avoid hidden state from prior runs.
  • Keep outputs tidy. Avoid giant outputs when a short summary works.
  • Prefer small tables, key metrics, or short printouts.
  • Keep the narrative skimmable. Use headings and short bullets, and avoid long paragraphs.
  • Leave helpful TODOs only when necessary, and label them clearly.
  • If execution is not possible, call out the risk and how to validate locally.