skills.rest
adobe
adobeOFFICIAL
Explore all skills by this author →
WebsiteGitHub

github-description

Generates GitHub pull request and issue descriptions following Spectrum Web Components conventions.

1.5k|261|Updated Nov 19, 2018
Search Tags:#generate#Documentation#gitHub# accessibility#spectrum web components#issue description#Pull request
One-click install
npx skills add https://github.com/adobe/spectrum-web-components --skill github-description
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: github-description
Source: https://github.com/adobe/spectrum-web-components/tree/main/.ai/skills/github-description
Command: npx skills add https://github.com/adobe/spectrum-web-components --skill github-description

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing consistent, complete GitHub pull request and issue descriptions is time-consuming, and contributors often forget required sections like the accessibility testing checklist, linked tickets, or proper labels. This Skill produces ready-to-paste PR and issue content that follows the Spectrum Web Components repository conventions.

Core Features & Use Cases

  • PR and Issue Drafting: Generates title, labels, and body using the repository's pull request template, including author/reviewer checklists and manual test cases.
  • Accessibility Testing Checklist: Populates keyboard and screen reader testing steps with component-specific instructions, as required by the project's contribution guidelines.
  • Conventions Enforcement: Applies title prefixes ([Bug], [Fix], [Docs], etc.), severity classification (SEV1–SEV5), valid repository labels, and Given/When/Then acceptance criteria.
  • Use Case: After finishing a bug fix for sp-button, ask for a PR description and receive a complete body with linked issue, checked author checklist, and documented accessibility test steps ready to paste into GitHub.

Quick Start

Write a PR description for my changes to the sp-button component that fixes issue #1234.

Frequently Asked Questions about github-description

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

FAQPage Schema
How do I write a GitHub PR description for Spectrum Web Components?▼

Provide your changes and a linked issue or Jira ticket, and the Skill generates a title, labels, and full body following the repository's pull request template. The output includes the author checklist, reviewer checklist, and manual test cases ready to paste into GitHub.

How to fill out the accessibility testing checklist in a pull request?▼

The checklist requires documented keyboard and screen reader testing steps with concrete instructions like Storybook paths, expected focus behavior, and announcements. For non-interactive components, state that there are no focusable parts and still document screen reader checks for roles and labels.

What title format should GitHub issues and PRs use?▼

Titles use the format [Component] Brief description in present tense, under 80 characters. Prefixes like [Bug], [Fix], [Docs], [Refactor], [Research], and [Test] categorize the change, with optional component names in brackets.

Can I generate a PR description without a linked ticket?▼

No. If no linked GitHub issue or Jira ticket is provided, the Skill prompts you to supply one before generating the description, since every PR must reference a related issue or ticket number.

Which labels can be applied to Spectrum Web Components pull requests?▼

Only labels that exist in the repository may be used, such as a11y, API, Breaking, feature, regression, and browser-specific labels. The repository has 160 labels total, listed at the GitHub labels page.

Related Skills

Explore More Software Engineering Skills→
officebeatsofficebeats
8

bug-chaser

Triage bug reports into engineering tickets with validated reproduction steps.

Community
Advanced
blakniteblaknite

submitting-pull-requests

Create and submit GitHub pull requests with context from Linear issues and commits.

Community
Intermediate
dinoudondinoudon

accessibility-audit

Audit web applications for WCAG 2.2 compliance across seven accessibility categories.

Community
Advanced
this-is-tobithis-is-tobi
5

pull-request

Generate structured markdown pull request descriptions with template detection.

Community
Basic