OpenParable
Skip to content
← Back to skills

Issue Spec Propose

Documents
issue-spec-propose

Issue Spec Propose is an Agent Skill for documents published in the higress-group/higress repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Create or continue proposal, SPEC, QUESTION, design, and TASK artifacts for an issue-spec change.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/higress-group/higress/blob/HEAD/.claude/skills/issue-spec-propose/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/issue-spec-propose, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Issue Spec Propose

Use when the user asks for /issue-spec:propose, issue-spec propose, creating a change proposal, drafting SPEC comments, or preparing design/tasks after questions converge.

Steps

  1. Create the proposal issue:

    issue-spec issue create proposal --repo higress-group/higress --change <change-name> --body-file <proposal.md>

  2. If the proposal body needs revision after discussion, update it in place:

    issue-spec issue update --repo higress-group/higress --issue <proposal-issue> --body-file <proposal.md> --summary "<what changed>"

  3. Add SPEC comments with issue-spec comment upsert --type SPEC. SPEC comments must use MUST/SHALL and WHEN/THEN scenarios.

  4. Add QUESTION comments for unresolved behavior with issue-spec question create and resolve blocking questions before design.

  5. Create the design issue after SPEC/QUESTION convergence:

    issue-spec issue create design --repo higress-group/higress --change <change-name> --proposal <proposal-issue-or-url> --body-file <design.md>

  6. Add TASK comments with issue-spec comment upsert --type TASK and link every TASK to covered SPEC comments with issue-spec link.

  7. Create the implement issue once tasks are ready:

    issue-spec issue create implement --repo higress-group/higress --change <change-name> --proposal <proposal-issue-or-url> --design <design-issue-or-url> --body-file <implement.md>

  8. Run issue-spec verify-links and fix missing backlinks before implementation.