skills.rest
Subaru-PFS
Subaru-PFSOFFICIAL
Explore all skills by this author →
WebsiteGitHub

pr-description

Standardize pull request descriptions for HoloViz repositories using organizational templates.

3|Updated May 31, 2023
Search Tags:#code review#documentation#pull request#technical writing#holoviz
One-click install
npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill pr-description-subaru-pfs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/Subaru-PFS/spt_etc_webapp/tree/main/.claude/skills/contributing-to-holoviz/skills/pr-description
Command: npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill pr-description-subaru-pfs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of writing consistent, high-quality pull request descriptions that effectively communicate technical changes to reviewers while adhering to specific organizational standards.

Core Features & Use Cases

  • Standardized Formatting: Ensures PRs follow the authoritative HoloViz template structure.
  • Communication Best Practices: Guides the user to write in the first person, avoid em dashes, and provide minimal reproducible examples.
  • Use Case: When submitting a new feature or bug fix to a HoloViz repository, use this Skill to structure your description, include necessary before/after evidence, and properly disclose AI usage.

Quick Start

Use the pr-description skill to draft a pull request summary for my recent changes to the plotting module.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I write a pull request description for a HoloViz repository?▼

To write a pull request description for a HoloViz repository, use a skill that enforces the authoritative HoloViz template structure, ensuring your technical changes and motivations are clearly communicated for peer review. It standardizes formatting automatically.

What should a technical pull request summary include for code review?▼

A technical pull request summary for code review should include clear documentation of code changes, motivations, testing procedures, conventional commit styles, and minimal reproducible examples for all submitted modifications to ensure clarity.

How do I format a bug fix PR to meet HoloViz communication guidelines?▼

To format a bug fix PR to meet HoloViz communication guidelines, structure your description using the standard template, write in the first person, avoid em dashes, and provide before and after evidence to support your modifications.

Do I need to include minimal reproducible examples in my HoloViz PR?▼

Yes, you need to include minimal reproducible examples in your HoloViz PR. The documentation process requires minimal reproducible examples for all submitted modifications to facilitate clear technical documentation and effective peer review.

How do I disclose AI usage in a pull request description?▼

To disclose AI usage in a pull request description, follow the standardized HoloViz template structure which prompts you to properly disclose AI usage alongside your technical documentation, motivations, and testing procedures for complete transparency.

Related Skills

Explore More Software Engineering Skills→
foutoucourfoutoucour

git-commit-helper

Generate conventional commit messages from staged git changes.

Community
Intermediate
awinogradovawinogradov
5

pr:resolve

Analyze pull request comments, apply code fixes, and reply to reviewers via GitHub API.

Community
Advanced
giruclawbotgiruclawbot

github-pr

Generate conventional commit PR titles and Summary/Changes/Testing descriptions.

Community
Intermediate
nodatallnodatall
2

clarifier

Coach guided revision of rough writing while preserving the original voice.

Community
Intermediate