gh-issue-clarifier

Clarifies ambiguous GitHub issues by defining scope, acceptance criteria, and solution options.

7|4|Updated Feb 12, 2024
One-click install
npx skills add https://github.com/ll7/robot_sf_ll7 --skill gh-issue-clarifier
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gh-issue-clarifier
Source: https://github.com/ll7/robot_sf_ll7/tree/main/.codex/skills/gh-issue-clarifier
Command: npx skills add https://github.com/ll7/robot_sf_ll7 --skill gh-issue-clarifier

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill tackles ambiguous or underspecified GitHub issues, ensuring they are actionable and well-defined for efficient development.

Core Features & Use Cases

  • Ambiguity Detection: Identifies vague problem statements, unclear acceptance criteria, or overly broad scopes.
  • Solution Proposal: Generates clear options with pros and cons when multiple implementation paths exist.
  • Scope Decomposition: Helps break down large issues into smaller, manageable tasks.
  • Decision Facilitation: Marks issues requiring maintainer input and structures the request for a decision.

Quick Start

Use the gh-issue-clarifier skill to refine the GitHub issue with ID 123.

Frequently Asked Questions about gh-issue-clarifier

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

FAQPage Schema
How do I refine ambiguous GitHub issues to make them implementation-ready?

You can clarify ambiguous GitHub issues by structuring scope definition and acceptance criteria. This Skill analyzes vague problem statements, proposes solutions with trade-offs, and breaks down broad tasks to make issues actionable for developers.

What is scope decomposition for large GitHub issues?

Scope decomposition for GitHub issues involves breaking down overly broad tasks into smaller, manageable sub-tasks. This technique ensures that large issues become actionable and well-defined, preventing development bottlenecks caused by unclear requirements.

Do I need the GitHub CLI to define acceptance criteria for issues?

Yes, the GitHub CLI (gh) is required to interact with issues for defining acceptance criteria. The Skill depends on this command-line tool to fetch issue details and process them into structured markdown outputs.

How do I facilitate maintainer decisions when multiple implementation paths exist?

You facilitate maintainer decisions by generating clear solution options with pros and cons. The Skill identifies issues requiring maintainer input and structures the request for a decision, ensuring clear evaluation of different implementation paths.

How does ambiguity detection work for underspecified GitHub issues?

Ambiguity detection works by identifying vague problem statements, unclear acceptance criteria, or overly broad scopes within GitHub issues. It analyzes the issue text to pinpoint missing information necessary for efficient development.