minimal-example

Create minimal reproducible code examples for HoloViz library issues.

3|Updated May 31, 2023

Search Tags:#debugging #reproducibility #bug-report #panel #holoviz #holoviews

Ready to run

npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill minimal-example-subaru-pfs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: minimal-example
Source: https://github.com/Subaru-PFS/spt_etc_webapp/tree/main/.claude/skills/contributing-to-holoviz/skills/minimal-example
Command: npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill minimal-example-subaru-pfs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires numpy, pandas, holoviews, panel.

What problem does it solve?

This Skill helps developers and users create standardized, self-contained, and reproducible code examples for HoloViz (Panel, HoloViews, hvPlot) issues, ensuring maintainers can immediately verify and fix bugs.

Core Features & Use Cases

Standardized Reproducers: Ensures all necessary backend extensions and data generation methods are included.
Render Verification: Enforces the use of explicit rendering commands to catch layout and projection errors that occur during execution.
Use Case: When reporting a rendering bug in a Panel dashboard, use this template to provide a minimal script that includes the backend declaration, seeded random data, and the explicit pn.serve call required for validation.

Quick Start

Generate a minimal reproducible example for a HoloViz issue by following the structure provided in the minimal-example skill documentation.

Frequently Asked Questions about minimal-example

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I create a reproducible bug report for a HoloViews rendering issue?▼

To create a reproducible HoloViews bug report, generate a self-contained script that includes explicit backend declarations, seeded random data generation, and the exact rendering commands needed to trigger the error. This ensures maintainers can immediately execute and verify the issue.

What is a minimal reproducible example for Panel dashboard bugs?▼

A minimal reproducible example for Panel dashboard bugs is a standardized, self-contained code snippet that includes all necessary backend extensions, seeded data generation, and explicit rendering calls like pn.serve to validate layout and projection errors during execution.

Do I need to declare a specific backend when reporting HoloViz issues?▼

Yes, you need to declare explicit backend extensions when reporting HoloViz issues. Declaring the backend ensures the rendering environment is unambiguous, allowing maintainers to reproduce the exact conditions that triggered the bug without guessing your configuration.

Why does my HoloViews bug report get ignored by maintainers?▼

Your HoloViews bug report may be ignored if it lacks a self-contained, reproducible example. Without explicit rendering commands, seeded data, and backend declarations, maintainers cannot immediately execute or verify the rendering error, delaying the debugging process.

Can I use this approach to standardize hvPlot pull request snippets?▼

Yes, you can standardize hvPlot pull request snippets by applying this structure to generate minimal, immediately executable code. Including seeded data generation and proper rendering commands ensures your PR contributions are verifiable and self-contained.