You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Implement an approved OpenSpec change and keep tasks in sync.
4
+
category: OpenSpec
5
+
tags: [openspec, apply]
6
+
---
7
+
<!-- OPENSPEC:START -->
8
+
**Guardrails**
9
+
- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
10
+
- Keep changes tightly scoped to the requested outcome.
11
+
- Refer to `openspec/AGENTS.md` (located inside the `openspec/` directory—run `ls openspec` or `openspec update` if you don't see it) if you need additional OpenSpec conventions or clarifications.
12
+
13
+
**Steps**
14
+
Track these steps as TODOs and complete them one by one.
15
+
1. Read `changes/<id>/proposal.md`, `design.md` (if present), and `tasks.md` to confirm scope and acceptance criteria.
16
+
2. Work through tasks sequentially, keeping edits minimal and focused on the requested change.
17
+
3. Confirm completion before updating statuses—make sure every item in `tasks.md` is finished.
18
+
4. Update the checklist after all work is done so each task is marked `- [x]` and reflects reality.
19
+
5. Reference `openspec list` or `openspec show <item>` when additional context is required.
20
+
21
+
**Reference**
22
+
- Use `openspec show <id> --json --deltas-only` if you need additional context from the proposal while implementing.
description: Archive a deployed OpenSpec change and update specs.
4
+
category: OpenSpec
5
+
tags: [openspec, archive]
6
+
---
7
+
<!-- OPENSPEC:START -->
8
+
**Guardrails**
9
+
- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
10
+
- Keep changes tightly scoped to the requested outcome.
11
+
- Refer to `openspec/AGENTS.md` (located inside the `openspec/` directory—run `ls openspec` or `openspec update` if you don't see it) if you need additional OpenSpec conventions or clarifications.
12
+
13
+
**Steps**
14
+
1. Determine the change ID to archive:
15
+
- If this prompt already includes a specific change ID (for example inside a `<ChangeId>` block populated by slash-command arguments), use that value after trimming whitespace.
16
+
- If the conversation references a change loosely (for example by title or summary), run `openspec list` to surface likely IDs, share the relevant candidates, and confirm which one the user intends.
17
+
- Otherwise, review the conversation, run `openspec list`, and ask the user which change to archive; wait for a confirmed change ID before proceeding.
18
+
- If you still cannot identify a single change ID, stop and tell the user you cannot archive anything yet.
19
+
2. Validate the change ID by running `openspec list` (or `openspec show <id>`) and stop if the change is missing, already archived, or otherwise not ready to archive.
20
+
3. Run `openspec archive <id> --yes` so the CLI moves the change and applies spec updates without prompts (use `--skip-specs` only for tooling-only work).
21
+
4. Review the command output to confirm the target specs were updated and the change landed in `changes/archive/`.
22
+
5. Validate with `openspec validate --strict` and inspect with `openspec show <id>` if anything looks off.
23
+
24
+
**Reference**
25
+
- Use `openspec list` to confirm change IDs before archiving.
26
+
- Inspect refreshed specs with `openspec list --specs` and address any validation issues before handing off.
description: Scaffold a new OpenSpec change and validate strictly.
4
+
category: OpenSpec
5
+
tags: [openspec, change]
6
+
---
7
+
<!-- OPENSPEC:START -->
8
+
**Guardrails**
9
+
- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
10
+
- Keep changes tightly scoped to the requested outcome.
11
+
- Refer to `openspec/AGENTS.md` (located inside the `openspec/` directory—run `ls openspec` or `openspec update` if you don't see it) if you need additional OpenSpec conventions or clarifications.
12
+
- Identify any vague or ambiguous details and ask the necessary follow-up questions before editing files.
13
+
- Do not write any code during the proposal stage. Only create design documents (proposal.md, tasks.md, design.md, and spec deltas). Implementation happens in the apply stage after approval.
14
+
15
+
**Steps**
16
+
1. Review `openspec/project.md`, run `openspec list` and `openspec list --specs`, and inspect related code or docs (e.g., via `rg`/`ls`) to ground the proposal in current behaviour; note any gaps that require clarification.
17
+
2. Choose a unique verb-led `change-id` and scaffold `proposal.md`, `tasks.md`, and `design.md` (when needed) under `openspec/changes/<id>/`.
18
+
3. Map the change into concrete capabilities or requirements, breaking multi-scope efforts into distinct spec deltas with clear relationships and sequencing.
19
+
4. Capture architectural reasoning in `design.md` when the solution spans multiple systems, introduces new patterns, or demands trade-off discussion before committing to specs.
20
+
5. Draft spec deltas in `changes/<id>/specs/<capability>/spec.md` (one folder per capability) using `## ADDED|MODIFIED|REMOVED Requirements` with at least one `#### Scenario:` per requirement and cross-reference related capabilities when relevant.
21
+
6. Draft `tasks.md` as an ordered list of small, verifiable work items that deliver user-visible progress, include validation (tests, tooling), and highlight dependencies or parallelizable work.
22
+
7. Validate with `openspec validate <id> --strict` and resolve every issue before sharing the proposal.
23
+
24
+
**Reference**
25
+
- Use `openspec show <id> --json --deltas-only` or `openspec show <spec> --type spec` to inspect details when validation fails.
26
+
- Search existing requirements with `rg -n "Requirement:|Scenario:" openspec/specs` before writing new ones.
27
+
- Explore the codebase with `rg <keyword>`, `ls`, or direct file reads so proposals align with current implementation realities.
0 commit comments