From 0fa2d10f40b08dc63d1f94ee99e9a07c14d76524 Mon Sep 17 00:00:00 2001 From: postlog Date: Sun, 28 Jun 2026 17:15:59 +0300 Subject: [PATCH] docs: migrate the change process to OpenSpec Adopt OpenSpec (the spec-driven schema) as the planning and change-documentation process, replacing the ADR catalog (the CHANGELOG stays). Seed a full spec baseline under openspec/specs/ (12 capabilities, validated by `openspec validate --specs --strict`), add the /opsx:* workflow under .claude/ (narrow the blanket .claude gitignore to settings.local.json so the commands/skills are tracked), and rewrite the process in AGENTS.md / CONTRIBUTING.md / README.md. Remove the docs/decisions/ ADR catalog (kept in git history); the migration's own rationale lives in the archived change openspec/changes/archive/2026-06-28-adopt-openspec/. Co-Authored-By: Claude Opus 4.8 --- .claude/commands/opsx/apply.md | 155 ++++++++++ .claude/commands/opsx/archive.md | 160 ++++++++++ .claude/commands/opsx/explore.md | 174 +++++++++++ .claude/commands/opsx/propose.md | 109 +++++++ .claude/commands/opsx/sync.md | 143 +++++++++ .claude/skills/openspec-apply-change/SKILL.md | 159 ++++++++++ .../skills/openspec-archive-change/SKILL.md | 117 +++++++ .claude/skills/openspec-explore/SKILL.md | 289 ++++++++++++++++++ .claude/skills/openspec-propose/SKILL.md | 113 +++++++ .claude/skills/openspec-sync-specs/SKILL.md | 147 +++++++++ .gitignore | 3 +- AGENTS.md | 49 +-- CHANGELOG.md | 33 +- CONTRIBUTING.md | 24 +- README.md | 3 +- apitest/auth/login_test.go | 2 +- apitest/users/create_test.go | 2 +- apitest/users/edit_test.go | 3 +- docs/decisions/0000-template.md | 24 -- .../decisions/0001-adopt-changelog-and-adr.md | 43 --- .../0002-ordered-migration-runner.md | 66 ---- docs/decisions/0003-validation-in-code.md | 68 ----- .../0004-optional-user-description.md | 58 ---- docs/decisions/0005-strict-mihomo-refs.md | 86 ------ .../decisions/0006-recursive-routing-rules.md | 111 ------- .../0008-subscription-link-catalog.md | 58 ---- .../0009-public-ready-and-english-docs.md | 55 ---- internal/entity/validation_errors.go | 2 +- openspec/changes/.gitkeep | 1 + openspec/changes/archive/.gitkeep | 1 + .../2026-06-28-adopt-openspec/design.md | 49 +++ .../2026-06-28-adopt-openspec/proposal.md | 32 ++ .../2026-06-28-adopt-openspec/tasks.md | 13 + openspec/config.yaml | 60 ++++ openspec/specs/admin-auth/spec.md | 119 ++++++++ openspec/specs/admin-users/spec.md | 133 ++++++++ openspec/specs/config-ownership/spec.md | 65 ++++ openspec/specs/database-migrations/spec.md | 62 ++++ openspec/specs/fleet/spec.md | 72 +++++ openspec/specs/mihomo-config/spec.md | 157 ++++++++++ openspec/specs/mihomo-rendering/spec.md | 64 ++++ openspec/specs/nodes/spec.md | 76 +++++ openspec/specs/platform/spec.md | 34 +++ openspec/specs/rule-provider-mirror/spec.md | 49 +++ openspec/specs/subscription-delivery/spec.md | 74 +++++ openspec/specs/user-provisioning/spec.md | 75 +++++ 46 files changed, 2776 insertions(+), 616 deletions(-) create mode 100644 .claude/commands/opsx/apply.md create mode 100644 .claude/commands/opsx/archive.md create mode 100644 .claude/commands/opsx/explore.md create mode 100644 .claude/commands/opsx/propose.md create mode 100644 .claude/commands/opsx/sync.md create mode 100644 .claude/skills/openspec-apply-change/SKILL.md create mode 100644 .claude/skills/openspec-archive-change/SKILL.md create mode 100644 .claude/skills/openspec-explore/SKILL.md create mode 100644 .claude/skills/openspec-propose/SKILL.md create mode 100644 .claude/skills/openspec-sync-specs/SKILL.md delete mode 100644 docs/decisions/0000-template.md delete mode 100644 docs/decisions/0001-adopt-changelog-and-adr.md delete mode 100644 docs/decisions/0002-ordered-migration-runner.md delete mode 100644 docs/decisions/0003-validation-in-code.md delete mode 100644 docs/decisions/0004-optional-user-description.md delete mode 100644 docs/decisions/0005-strict-mihomo-refs.md delete mode 100644 docs/decisions/0006-recursive-routing-rules.md delete mode 100644 docs/decisions/0008-subscription-link-catalog.md delete mode 100644 docs/decisions/0009-public-ready-and-english-docs.md create mode 100644 openspec/changes/.gitkeep create mode 100644 openspec/changes/archive/.gitkeep create mode 100644 openspec/changes/archive/2026-06-28-adopt-openspec/design.md create mode 100644 openspec/changes/archive/2026-06-28-adopt-openspec/proposal.md create mode 100644 openspec/changes/archive/2026-06-28-adopt-openspec/tasks.md create mode 100644 openspec/config.yaml create mode 100644 openspec/specs/admin-auth/spec.md create mode 100644 openspec/specs/admin-users/spec.md create mode 100644 openspec/specs/config-ownership/spec.md create mode 100644 openspec/specs/database-migrations/spec.md create mode 100644 openspec/specs/fleet/spec.md create mode 100644 openspec/specs/mihomo-config/spec.md create mode 100644 openspec/specs/mihomo-rendering/spec.md create mode 100644 openspec/specs/nodes/spec.md create mode 100644 openspec/specs/platform/spec.md create mode 100644 openspec/specs/rule-provider-mirror/spec.md create mode 100644 openspec/specs/subscription-delivery/spec.md create mode 100644 openspec/specs/user-provisioning/spec.md diff --git a/.claude/commands/opsx/apply.md b/.claude/commands/opsx/apply.md new file mode 100644 index 0000000..f540757 --- /dev/null +++ b/.claude/commands/opsx/apply.md @@ -0,0 +1,155 @@ +--- +name: "OPSX: Apply" +description: Implement tasks from an OpenSpec change (Experimental) +category: Workflow +tags: [workflow, artifacts, experimental] +--- + +Implement tasks from an OpenSpec change. + +**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store ` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`). Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root. + +**Input**: Optionally specify a change name (e.g., `/opsx:apply add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes. + +**Steps** + +1. **Select the change** + + If a name is provided, use it. Otherwise: + - Infer from conversation context if the user mentioned a change + - Auto-select if only one active change exists + - If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select + + Always announce: "Using change: " and how to override (e.g., `/opsx:apply `). + +2. **Check status to understand the schema** + ```bash + openspec status --change "" --json + ``` + Parse the JSON to understand: + - `schemaName`: The workflow being used (e.g., "spec-driven") + - `planningHome`, `changeRoot`, and `actionContext`: planning scope and edit constraints + - Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others) + +3. **Get apply instructions** + + ```bash + openspec instructions apply --change "" --json + ``` + + This returns: + - `contextFiles`: artifact ID -> array of concrete file paths (varies by schema) + - Progress (total, complete, remaining) + - Task list with status + - Dynamic instruction based on current state + + **Handle states:** + - If `state: "blocked"` (missing artifacts): show message, suggest using `/opsx:continue` + - If `state: "all_done"`: congratulate, suggest archive + - Otherwise: proceed to implementation + +4. **Read context files** + + Read every file path listed under `contextFiles` from the apply instructions output. + The files depend on the schema being used: + - **spec-driven**: proposal, specs, design, tasks + - Other schemas: follow the contextFiles from CLI output + +5. **Show current progress** + + Display: + - Schema being used + - Progress: "N/M tasks complete" + - Remaining tasks overview + - Dynamic instruction from CLI + +6. **Implement tasks (loop until done or blocked)** + + For each pending task: + - Show which task is being worked on + - Make the code changes required + - Keep changes minimal and focused + - Mark task complete in the tasks file: `- [ ]` → `- [x]` + - Continue to next task + + **Pause if:** + - Task is unclear → ask for clarification + - Implementation reveals a design issue → suggest updating artifacts + - Error or blocker encountered → report and wait for guidance + - User interrupts + +7. **On completion or pause, show status** + + Display: + - Tasks completed this session + - Overall progress: "N/M tasks complete" + - If all done: suggest archive + - If paused: explain why and wait for guidance + +**Output During Implementation** + +``` +## Implementing: (schema: ) + +Working on task 3/7: +[...implementation happening...] +✓ Task complete + +Working on task 4/7: +[...implementation happening...] +✓ Task complete +``` + +**Output On Completion** + +``` +## Implementation Complete + +**Change:** +**Schema:** +**Progress:** 7/7 tasks complete ✓ + +### Completed This Session +- [x] Task 1 +- [x] Task 2 +... + +All tasks complete! You can archive this change with `/opsx:archive`. +``` + +**Output On Pause (Issue Encountered)** + +``` +## Implementation Paused + +**Change:** +**Schema:** +**Progress:** 4/7 tasks complete + +### Issue Encountered + + +**Options:** +1.