te-quanbzhang/skills-pool

openspec-propose

Propose a new change with all artifacts generated in one step.

ソースを見る
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

Propose a new change - create the change and generate all artifacts in one step.

I'll first use CodeGraph to explore the codebase for relevant context, then create all artifacts with that understanding.

Artifacts to generate:

  • proposal.md (what & why)
  • design.md (how)
  • tasks.md (implementation steps)

When ready to implement, run /opsx:apply


Input: The user's request should include a change name (kebab-case) OR a description of what they want to build.

Steps

  1. If no clear input provided, ask what they want to build

Use the AskUserQuestion tool (open-ended, no preset options) to ask:

"What change do you want to work on? Describe what you want to build or fix."

From their description, derive a kebab-case name (e.g., "add user authentication" → add-user-auth).

IMPORTANT: Do NOT proceed without understanding what the user wants to build.

  1. Run CodeGraph exploration for codebase context

Before creating the change, use CodeGraph to explore relevant code:

a. Extract key technical terms from the user's change description. Identify 2-4 core concepts (e.g., feature name, components, data flow).

b. Run codegraph explore to gather code context:

bash
      codegraph explore "<key terms>"
  • Use the most relevant terms as the query
  • If multiple distinct topics, run multiple explore commands

c. Review the results. CodeGraph returns:

  • Relevant source symbols and their verbatim source code
  • Call paths between related symbols
  • Dynamic dispatch relationships

d. Record key findings for use as context in artifact creation:

  • Which files/modules are directly relevant
  • Architecture patterns and relationships discovered
  • Integration points and dependencies
The codegraph results will be used as context when creating the proposal, design, and task artifacts below.
  1. Create the change directory
bash
   openspec new change "<name>"

This creates a scaffolded change in the planning home resolved by the CLI with .openspec.yaml.

  1. Get the artifact build order
bash
   openspec status --change "<name>" --json

Parse the JSON to get:

  • applyRequires: array of artifact IDs needed before implementation (e.g., ["tasks"])
  • artifacts: list of all artifacts with their status and dependencies
  • planningHome, changeRoot, artifactPaths, and actionContext: path and scope context. Use these instead of assuming repo-local paths.
  1. Create artifacts in sequence until apply-ready

Use the TodoWrite tool to track progress through the artifacts.

Use CodeGraph context: When creating each artifact (proposal, design, tasks), incorporate the CodeGraph findings from step 2 as part of your understanding of the codebase. This ensures the artifacts are grounded in actual code structure and relationships.

Loop through artifacts in dependency order (artifacts with no pending dependencies first):

a. For each artifact that is `ready` (dependencies satisfied):

  • Get instructions:
bash
        openspec instructions <artifact-id> --change "<name>" --json
  • The instructions JSON includes:
  • context: Project background (constraints for you - do NOT include in output)
  • rules: Artifact-specific rules (constraints for you - do NOT include in output)
  • template: The structure to use for your output file
  • instruction: Schema-specific guidance for this artifact type
  • resolvedOutputPath: Resolved path or pattern to write the artifact
  • dependencies: Completed artifacts to read for context
  • Read any completed dependency files for context
  • Create the artifact file using template as the structure and write it to resolvedOutputPath
  • Apply context and rules as constraints - but do NOT copy them into the file
  • Show brief progress: "Created <artifact-id>"

b. Continue until all `applyRequires` artifacts are complete

  • After creating each artifact, re-run openspec status --change "<name>" --json
  • Check if every artifact ID in applyRequires has status: "done" in the artifacts array
  • Stop when all applyRequires artifacts are done

c. If an artifact requires user input (unclear context):

  • Use AskUserQuestion tool to clarify
  • Then continue with creation
  1. Show final status
bash
   openspec status --change "<name>"

Output

After completing all artifacts, summarize with CodeGraph context included:

Summary

  • Change name and location
  • List of artifacts created with brief descriptions

CodeGraph Codebase Context

  • Summarize the key codegraph findings that were used
  • Relevant files/modules discovered
  • Architecture patterns and relationships
  • Integration points identified
  • This helps the user understand what codebase context informed the proposal

Next Steps

  • What's ready: "All artifacts created! Ready for implementation."
  • Prompt: "Run /opsx:apply or ask me to implement to start working on the tasks."

Artifact Creation Guidelines

  • Follow the instruction field from openspec instructions for each artifact type
  • The schema defines what each artifact should contain - follow it
  • Read dependency artifacts for context before creating new ones
  • Use template as the structure for your output file - fill in its sections
  • IMPORTANT: context and rules are constraints for YOU, not content for the file
  • Do NOT copy <context>, <rules>, <project_context> blocks into the artifact
  • These guide what you write, but should never appear in the output

Guardrails

  • Create ALL artifacts needed for implementation (as defined by schema's apply.requires)
  • Always read dependency artifacts before creating a new one
  • If context is critically unclear, ask the user - but prefer running codegraph explore with different terms to find relevant code
  • If a change with that name already exists, ask if user wants to continue it or create a new one
  • Verify each artifact file exists after writing before proceeding to next
  • If codegraph explore returns no meaningful results, proceed without it - CodeGraph is an enhancement, not a blocker
同じリポジトリから

関連する Skills

すべての Skills