issue-spec-propose

Creates proposal, SPEC, QUESTION, design, and TASK artifacts for issue-spec changes.

9.3k|1.3k|Updated Oct 27, 2022
One-click install
npx skills add https://github.com/alibaba/higress --skill issue-spec-propose
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: issue-spec-propose
Source: https://github.com/alibaba/higress/tree/main/.agents/skills/issue-spec-propose
Command: npx skills add https://github.com/alibaba/higress --skill issue-spec-propose

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It structures the authoring of issue-spec change artifacts so proposals, SPECs, QUESTIONs, designs, and TASKs follow a consistent typed-ID and phase workflow instead of ad-hoc issue text.

Core Features & Use Cases

  • Typed Artifact Authoring: Creates proposal, Design, SPEC, QUESTION, and TASK artifacts with canonical ID rules like QUESTION-44001 scoped per issue.
  • Blocking Question Tracking: Records every unresolved decision as a typed QUESTION with choice models rather than leaving open decisions in prose.
  • Canonical Comment Generation: Generates SPEC comments with testable WHEN/THEN requirements and TASK comments covering execution planning and ownership.
  • Use Case: When starting a new change in the higress repository, run the propose workflow to create the proposal issue, discover open questions, and produce SPEC and TASK comments ready for implementation planning.

Quick Start

Ask the assistant to run /issue-spec:propose to draft a proposal, SPEC, and TASK plan for your issue.

Frequently Asked Questions about issue-spec-propose

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

FAQPage Schema
How do I create a proposal with issue-spec?

Create the proposal issue with issue-spec issue create proposal --repo higress-group/higress --body-file <file>, then run the first QUESTION discovery pass. The proposal states the confirmed problem and intended change, not unconfirmed investigation notes.

How are typed IDs like QUESTION-44001 assigned?

Every new typed ID uses the format <TYPE>-<issue><three-digit sequence>, so Issue 44 starts at QUESTION-44001. Sequences 001-999 are allocated within the target issue and type after reading that issue's typed comments, and legacy IDs are never renumbered.

What is the difference between a simple issue and a proposal?

A simple issue holds unconfirmed investigation, reproduction, or triage notes, while a proposal states a confirmed problem and intended change. Investigation issues must never be promoted into proposals or carry SPEC and Design artifacts.

Does the skill require the issue-spec CLI?

Yes, the skill requires the issue-spec CLI as stated in its compatibility metadata. All artifact creation, question creation, and comment generation commands run through that CLI.

When should --allow-noncanonical or --allow-legacy-id be used?

--allow-noncanonical is a migration bypass for SPEC generation, not normal authoring, and --allow-legacy-id is only for intentional legacy-compatible creates. New writes reject wrong issue prefixes by default.