contributing-to-holoviz

Standardize PR descriptions, documentation, and testing for HoloViz packages.

3|Updated May 31, 2023
One-click install
npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill contributing-to-holoviz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: contributing-to-holoviz
Source: https://github.com/Subaru-PFS/spt_etc_webapp/tree/main/.claude/skills/contributing-to-holoviz
Command: npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill contributing-to-holoviz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill provides a structured framework for maintaining and contributing to HoloViz packages, ensuring consistency across PR reviews, testing, documentation, and code refactoring.

Core Features & Use Cases

  • Standardized Workflows: Provides specific guidelines for PR descriptions, documentation updates, and test coverage.
  • Quality Assurance: Offers best practices for code cleanup, minimal example creation, and edge-case testing.
  • Use Case: When submitting a new feature to Panel or HoloViews, use this Skill to ensure your PR description, documentation, and test suite meet the project's high standards for maintainability.

Quick Start

Use the contributing-to-holoviz skill to review the current pull request and ensure all documentation and testing requirements are met.

Frequently Asked Questions about contributing-to-holoviz

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

FAQPage Schema
How do I write a pull request description for Panel or HoloViews?

Standardized contribution workflows provide specific guidelines for PR descriptions, ensuring your Panel or HoloViews pull requests meet the project's high maintainability and review standards.

What are the Diátaxis documentation standards for HoloViz packages?

Diátaxis documentation standards for HoloViz packages structure documentation into tutorials, how-to guides, explanation, and reference. This Skill enforces adherence to these standards during documentation updates and refactoring.

How do I create unit tests for HoloViews contributions?

To create unit tests for HoloViews contributions, follow specific HoloViz testing patterns that include best practices for code cleanup, minimal example creation, and edge-case testing to ensure robust coverage.

Does this contribution workflow support hvPlot and HoloViews simultaneously?

Yes, the contribution workflow supports the entire HoloViz ecosystem, including hvPlot, HoloViews, and Panel, providing a unified framework for maintaining and contributing across all these packages.

What's the best way to refactor code in the HoloViz ecosystem?

The best way to refactor code in the HoloViz ecosystem is using structured maintenance workflows that offer specific best practices for code cleanup and quality assurance, ensuring refactoring meets project standards.

Why does my HoloViz pull request fail code review?

Your HoloViz pull request may fail code review if it lacks adherence to specific testing patterns, Diátaxis documentation standards, or proper PR description guidelines, all enforced by the structured contribution workflow.