-
-
Notifications
You must be signed in to change notification settings - Fork 43
Update openspec #871
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update openspec #871
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| --- | ||
| description: Create a change and generate all artifacts needed for implementation in one go (preferred OpenSpec workflow) | ||
| --- | ||
|
|
||
| Create a change and generate all artifacts needed for implementation in one go. | ||
|
|
||
| This is the preferred user-facing alias of the fast-forward workflow. | ||
|
|
||
| **Input**: The argument after `/opsx:propose` is the change name (kebab-case), OR a description of what the user wants to build. | ||
|
|
||
| **Steps** | ||
|
|
||
| 1. **If no 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. | ||
|
|
||
| 2. **Create the change directory** | ||
| ```bash | ||
| openspec new change "<name>" | ||
| ``` | ||
| This creates a scaffolded change at `openspec/changes/<name>/`. | ||
|
|
||
| 3. **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 | ||
|
|
||
| 4. **Create artifacts in sequence until apply-ready** | ||
|
|
||
| Use the **TodoWrite tool** to track progress through the artifacts. | ||
|
|
||
| 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 | ||
| - `outputPath`: Where 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 | ||
| - 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 | ||
|
|
||
| 5. **Show final status** | ||
| ```bash | ||
| openspec status --change "<name>" | ||
| ``` | ||
|
|
||
| **Output** | ||
|
|
||
| After completing all artifacts, summarize: | ||
| - Change name and location | ||
| - List of artifacts created with brief descriptions | ||
| - What's ready: "All artifacts created! Ready for implementation." | ||
| - Prompt: "Run `/opsx:apply` to start implementing." | ||
|
|
||
| **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 making reasonable decisions to keep momentum | ||
| - 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.