devspec 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- devspec-0.1.0.dist-info/METADATA +522 -0
- devspec-0.1.0.dist-info/RECORD +133 -0
- devspec-0.1.0.dist-info/WHEEL +4 -0
- devspec-0.1.0.dist-info/entry_points.txt +2 -0
- devspec-0.1.0.dist-info/licenses/LICENSE +201 -0
- devspec_installer/__init__.py +3 -0
- devspec_installer/__main__.py +5 -0
- devspec_installer/cli.py +615 -0
- devspec_installer/payload/.agents/rules/devspec-workflow.md +25 -0
- devspec_installer/payload/.agents/skills/devspec-clarify.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-codebase-structure.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-coding-standards.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-diagram.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-extract.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-finalize.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-implement.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-projectcontext.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-review.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-rules.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-story.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-tasks.md +14 -0
- devspec_installer/payload/.agents/skills/devspec-techstack.md +14 -0
- devspec_installer/payload/.claude/skills/devspec-clarify/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-codebase-structure/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-coding-standards/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-diagram/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-extract/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-finalize/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-implement/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-projectcontext/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-review/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-rules/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-story/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-tasks/SKILL.md +13 -0
- devspec_installer/payload/.claude/skills/devspec-techstack/SKILL.md +13 -0
- devspec_installer/payload/.cursor/rules/devspec-workflow.mdc +23 -0
- devspec_installer/payload/.gemini/commands/devspec/clarify.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/codebase-structure.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/coding-standards.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/diagram.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/extract.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/finalize.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/implement.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/projectcontext.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/review.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/rules.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/story.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/tasks.toml +14 -0
- devspec_installer/payload/.gemini/commands/devspec/techstack.toml +14 -0
- devspec_installer/payload/.github/agents/devspec.clarify.agent.md +39 -0
- devspec_installer/payload/.github/agents/devspec.codebase-structure.agent.md +39 -0
- devspec_installer/payload/.github/agents/devspec.coding-standards.agent.md +40 -0
- devspec_installer/payload/.github/agents/devspec.diagram.agent.md +76 -0
- devspec_installer/payload/.github/agents/devspec.extract.agent.md +91 -0
- devspec_installer/payload/.github/agents/devspec.finalize.agent.md +51 -0
- devspec_installer/payload/.github/agents/devspec.implement-task.agent.md +67 -0
- devspec_installer/payload/.github/agents/devspec.projectcontext.agent.md +34 -0
- devspec_installer/payload/.github/agents/devspec.review.agent.md +42 -0
- devspec_installer/payload/.github/agents/devspec.rules.agent.md +35 -0
- devspec_installer/payload/.github/agents/devspec.story.agent.md +54 -0
- devspec_installer/payload/.github/agents/devspec.tasks.agent.md +44 -0
- devspec_installer/payload/.github/agents/devspec.techstack.agent.md +35 -0
- devspec_installer/payload/.github/prompts/PATTERNS.md +278 -0
- devspec_installer/payload/.github/prompts/README.md +92 -0
- devspec_installer/payload/.github/prompts/devspec.clarify.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.codebase-structure.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.coding-standards.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.diagram.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.extract.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.finalize.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.implement.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.projectcontext.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.review.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.rules.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.story.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.tasks.prompt.md +11 -0
- devspec_installer/payload/.github/prompts/devspec.techstack.prompt.md +11 -0
- devspec_installer/payload/.github/skills/exploration-recovery/SKILL.md +45 -0
- devspec_installer/payload/.github/workflows/python-package-ci.yml +42 -0
- devspec_installer/payload/.github/workflows/python-package-publish.yml +69 -0
- devspec_installer/payload/.github/workflows/winget-package-publish.yml +110 -0
- devspec_installer/payload/AGENTS.md +80 -0
- devspec_installer/payload/GEMINI.md +35 -0
- devspec_installer/payload/README.md +301 -0
- devspec_installer/payload/devspec/adapters/README.md +53 -0
- devspec_installer/payload/devspec/adapters/antigravity.md +52 -0
- devspec_installer/payload/devspec/adapters/claude-code.md +32 -0
- devspec_installer/payload/devspec/adapters/codex-skills/devspec-workflow/SKILL.md +17 -0
- devspec_installer/payload/devspec/adapters/codex.md +22 -0
- devspec_installer/payload/devspec/adapters/command-registry.md +38 -0
- devspec_installer/payload/devspec/adapters/compatibility-matrix.md +21 -0
- devspec_installer/payload/devspec/adapters/copilot.md +20 -0
- devspec_installer/payload/devspec/adapters/cursor.md +22 -0
- devspec_installer/payload/devspec/adapters/enterprise-governance.md +36 -0
- devspec_installer/payload/devspec/adapters/gemini-cli.md +54 -0
- devspec_installer/payload/devspec/adapters/validation-flows.md +90 -0
- devspec_installer/payload/devspec/architecture/_template/artifact-queue.md +27 -0
- devspec_installer/payload/devspec/architecture/_template/decision.md +45 -0
- devspec_installer/payload/devspec/architecture/_template/diagram.md +62 -0
- devspec_installer/payload/devspec/architecture/_template/overview.md +37 -0
- devspec_installer/payload/devspec/architecture/artifact-queue.md +27 -0
- devspec_installer/payload/devspec/architecture/diagrams/README.md +44 -0
- devspec_installer/payload/devspec/architecture/overview.md +37 -0
- devspec_installer/payload/devspec/constitution.md +26 -0
- devspec_installer/payload/devspec/foundation/_template/codebase-structure.md +64 -0
- devspec_installer/payload/devspec/foundation/_template/coding-standards.md +46 -0
- devspec_installer/payload/devspec/foundation/_template/discovery-exclusions.md +52 -0
- devspec_installer/payload/devspec/foundation/_template/exploration-state.md +15 -0
- devspec_installer/payload/devspec/foundation/_template/extraction-state.md +45 -0
- devspec_installer/payload/devspec/foundation/_template/project-context.md +37 -0
- devspec_installer/payload/devspec/foundation/_template/provider-integrations.md +94 -0
- devspec_installer/payload/devspec/foundation/_template/rules.md +54 -0
- devspec_installer/payload/devspec/foundation/_template/tech-stack.md +49 -0
- devspec_installer/payload/devspec/foundation/codebase-structure.md +64 -0
- devspec_installer/payload/devspec/foundation/coding-standards.md +46 -0
- devspec_installer/payload/devspec/foundation/discovery-exclusions.md +52 -0
- devspec_installer/payload/devspec/foundation/extraction-state.md +45 -0
- devspec_installer/payload/devspec/foundation/project-context.md +33 -0
- devspec_installer/payload/devspec/foundation/provider-integrations.md +94 -0
- devspec_installer/payload/devspec/foundation/rules.md +52 -0
- devspec_installer/payload/devspec/foundation/tech-stack.md +49 -0
- devspec_installer/payload/devspec/glossary.md +111 -0
- devspec_installer/payload/devspec/work-items/_template/clarify.md +28 -0
- devspec_installer/payload/devspec/work-items/_template/decisions.md +9 -0
- devspec_installer/payload/devspec/work-items/_template/diagrams.md +42 -0
- devspec_installer/payload/devspec/work-items/_template/finalize.md +65 -0
- devspec_installer/payload/devspec/work-items/_template/implement.md +63 -0
- devspec_installer/payload/devspec/work-items/_template/meta.md +63 -0
- devspec_installer/payload/devspec/work-items/_template/notes.md +7 -0
- devspec_installer/payload/devspec/work-items/_template/review.md +41 -0
- devspec_installer/payload/devspec/work-items/_template/story.md +59 -0
- devspec_installer/payload/devspec/work-items/_template/tasks.md +38 -0
- devspec_installer/payload/packaging/devspec-profiles.json +60 -0
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Multi-Agent Adapter Guide
|
|
2
|
+
|
|
3
|
+
Use this directory to keep multi-agent support additive. GitHub Copilot prompt and agent files remain the reference implementation; adapters for Claude Code, OpenAI Codex, Cursor, Gemini CLI, Google Antigravity, and future tools must preserve that intent instead of redefining the workflow.
|
|
4
|
+
|
|
5
|
+
## Adapter Contract
|
|
6
|
+
|
|
7
|
+
| Contract area | Requirement |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| Reference source | Use `.github/prompts/*.prompt.md` and `.github/agents/*.agent.md` as the canonical command and agent contracts. |
|
|
10
|
+
| Command registry | Use `devspec/adapters/command-registry.md` for provider-neutral command names, required inputs, outputs, mutation levels, and handoffs. |
|
|
11
|
+
| State source | Recover from Git-tracked `devspec/` artifacts before relying on chat history or tool memory. |
|
|
12
|
+
| Intent preservation | Do not change command purpose, required input, output artifacts, status values, handoff order, readiness gates, review gates, or recovery behavior. |
|
|
13
|
+
| Platform gaps | Document unsupported behavior as a limitation; do not hide gaps by changing `devspec` semantics. |
|
|
14
|
+
| Integration model | Keep provider lookup, CI, scanners, and enterprise systems behind MCP servers, approved connectors, or equivalent internal tools. |
|
|
15
|
+
|
|
16
|
+
## Adapter Files
|
|
17
|
+
|
|
18
|
+
| Adapter | Primary files | Role |
|
|
19
|
+
| --- | --- | --- |
|
|
20
|
+
| GitHub Copilot | `.github/prompts/`, `.github/agents/`, `.github/skills/` | Native `/devspec.*` command implementation and reference adapter. |
|
|
21
|
+
| Claude Code | `.claude/skills/devspec-*/SKILL.md` | Project skills that invoke the same command contract from Claude Code. |
|
|
22
|
+
| OpenAI Codex | `AGENTS.md`, `devspec/adapters/codex.md` | Always-on repository guidance and Codex usage notes for the same workflow. |
|
|
23
|
+
| Cursor | `.cursor/rules/devspec-workflow.mdc`, `AGENTS.md` | Project rule guidance for Cursor Agent and Inline Edit. |
|
|
24
|
+
| Gemini CLI | `GEMINI.md`, `.gemini/commands/devspec/*.toml` | Gemini context and project custom commands for the same workflow. |
|
|
25
|
+
| Google Antigravity | `.agents/rules/devspec-workflow.md`, `.agents/skills/devspec-*.md` | Workspace rule and skills for Antigravity agents. |
|
|
26
|
+
| Future tools | `devspec/adapters/command-registry.md`, `AGENTS.md` | Map new tool-specific commands, skills, or rules to the same registry. |
|
|
27
|
+
|
|
28
|
+
## Usage Examples
|
|
29
|
+
|
|
30
|
+
For install steps, workflow walkthroughs, and copy-ready command examples across AI coding agents, see [`../../docs/how-to/README.md`](../../docs/how-to/README.md).
|
|
31
|
+
|
|
32
|
+
## Implementation Order
|
|
33
|
+
|
|
34
|
+
1. Confirm the command exists in `devspec/adapters/command-registry.md`.
|
|
35
|
+
2. Read the canonical Copilot prompt and agent files named in the registry.
|
|
36
|
+
3. Implement a thin adapter wrapper for the target tool.
|
|
37
|
+
4. Preserve required inputs, artifact writes, gates, handoffs, recovery behavior, and next-action behavior.
|
|
38
|
+
5. Validate with `devspec/adapters/validation-flows.md`.
|
|
39
|
+
|
|
40
|
+
## No-Intent-Drift Rules
|
|
41
|
+
|
|
42
|
+
An adapter has drifted when it does any of the following:
|
|
43
|
+
|
|
44
|
+
- changes the purpose of a command or stage
|
|
45
|
+
- drops a required input or confirmation
|
|
46
|
+
- writes a different artifact set
|
|
47
|
+
- relaxes readiness, review, repository-access, or security gates
|
|
48
|
+
- renames or invents status values outside `devspec/glossary.md`
|
|
49
|
+
- changes the registered next command or handoff order
|
|
50
|
+
- treats platform-specific limitations as workflow changes
|
|
51
|
+
- relies on chat memory when a Git-tracked `devspec` artifact exists
|
|
52
|
+
|
|
53
|
+
If exact behavior cannot be represented on a platform, record the gap in `devspec/adapters/compatibility-matrix.md` and keep the workflow contract unchanged.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Google Antigravity Adapter
|
|
2
|
+
|
|
3
|
+
Google Antigravity support is implemented through workspace rules under `.agents/rules/` and workspace skills under `.agents/skills/`.
|
|
4
|
+
|
|
5
|
+
## Invocation Model
|
|
6
|
+
|
|
7
|
+
| Devspec command | Antigravity skill |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `/devspec.extract` | `/devspec-extract` |
|
|
10
|
+
| `/devspec.projectcontext` | `/devspec-projectcontext` |
|
|
11
|
+
| `/devspec.techstack` | `/devspec-techstack` |
|
|
12
|
+
| `/devspec.codebase-structure` | `/devspec-codebase-structure` |
|
|
13
|
+
| `/devspec.coding-standards` | `/devspec-coding-standards` |
|
|
14
|
+
| `/devspec.rules` | `/devspec-rules` |
|
|
15
|
+
| `/devspec.story` | `/devspec-story` |
|
|
16
|
+
| `/devspec.clarify` | `/devspec-clarify` |
|
|
17
|
+
| `/devspec.finalize` | `/devspec-finalize` |
|
|
18
|
+
| `/devspec.tasks` | `/devspec-tasks` |
|
|
19
|
+
| `/devspec.implement` | `/devspec-implement` |
|
|
20
|
+
| `/devspec.review` | `/devspec-review` |
|
|
21
|
+
| `/devspec.diagram` | `/devspec-diagram` |
|
|
22
|
+
|
|
23
|
+
## Adapter Rules
|
|
24
|
+
|
|
25
|
+
- `.agents/rules/devspec-workflow.md` provides always-on workspace guidance.
|
|
26
|
+
- `.agents/skills/devspec-*.md` provides command-like wrappers for each canonical command.
|
|
27
|
+
- Each skill references `devspec/adapters/command-registry.md` and the matching Copilot prompt and agent files.
|
|
28
|
+
- Do not add Antigravity workflow files until the target workflow file location and format are confirmed for the team.
|
|
29
|
+
- Antigravity artifacts, task lists, and implementation plans are transient helpers; Git-tracked `devspec/` artifacts remain canonical.
|
|
30
|
+
|
|
31
|
+
## Enterprise Safety
|
|
32
|
+
|
|
33
|
+
| Area | Guidance |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| Rules | Workspace rules live under `.agents/rules/`; keep the devspec rule broad, short, and always on. |
|
|
36
|
+
| Skills | Workspace skills live under `.agents/skills/` and become slash-invokable command wrappers. |
|
|
37
|
+
| Permissions | Prefer Ask or Request Review for terminal commands, browser actions, MCP calls, non-workspace file access, and artifact application. |
|
|
38
|
+
| Strict mode | Use strict mode or equivalent review posture for regulated, security-sensitive, or unfamiliar repositories. |
|
|
39
|
+
| Sandboxing | Enable terminal sandboxing where available; deny network access unless the workflow requires it. |
|
|
40
|
+
| Project boundaries | Keep projects scoped to the repositories recorded in `devspec/foundation/codebase-structure.md`. |
|
|
41
|
+
| Artifact review | Treat Antigravity implementation plans and code diffs as review surfaces; canonical completion evidence still belongs in `devspec` artifacts. |
|
|
42
|
+
| Secrets | Keep credentials, tokens, local settings, and provider secrets outside rules, skills, prompts, and artifacts. |
|
|
43
|
+
|
|
44
|
+
## Known Gaps
|
|
45
|
+
|
|
46
|
+
- Exact `/devspec.*` slash parity is not assumed; Antigravity skills use `/devspec-story` style names.
|
|
47
|
+
- Antigravity workflows are intentionally not shipped until their workspace file contract is confirmed for the target environment.
|
|
48
|
+
- Permission, sandbox, project, and artifact-review behavior depends on the user's Antigravity project settings.
|
|
49
|
+
|
|
50
|
+
## Validation
|
|
51
|
+
|
|
52
|
+
Run the new repository, existing repository, story, and cross-tool recovery flows in `devspec/adapters/validation-flows.md` with Antigravity before treating the adapter as enterprise-ready.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Claude Code Adapter
|
|
2
|
+
|
|
3
|
+
Claude Code support is implemented through project skills under `.claude/skills/devspec-*/SKILL.md`.
|
|
4
|
+
|
|
5
|
+
## Invocation Model
|
|
6
|
+
|
|
7
|
+
| Devspec command | Claude skill |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `/devspec.extract` | `/devspec-extract` |
|
|
10
|
+
| `/devspec.projectcontext` | `/devspec-projectcontext` |
|
|
11
|
+
| `/devspec.techstack` | `/devspec-techstack` |
|
|
12
|
+
| `/devspec.codebase-structure` | `/devspec-codebase-structure` |
|
|
13
|
+
| `/devspec.coding-standards` | `/devspec-coding-standards` |
|
|
14
|
+
| `/devspec.rules` | `/devspec-rules` |
|
|
15
|
+
| `/devspec.story` | `/devspec-story` |
|
|
16
|
+
| `/devspec.clarify` | `/devspec-clarify` |
|
|
17
|
+
| `/devspec.finalize` | `/devspec-finalize` |
|
|
18
|
+
| `/devspec.tasks` | `/devspec-tasks` |
|
|
19
|
+
| `/devspec.implement` | `/devspec-implement` |
|
|
20
|
+
| `/devspec.review` | `/devspec-review` |
|
|
21
|
+
| `/devspec.diagram` | `/devspec-diagram` |
|
|
22
|
+
|
|
23
|
+
## Adapter Rules
|
|
24
|
+
|
|
25
|
+
- Each skill is a thin wrapper around the canonical command registry.
|
|
26
|
+
- Each skill references the matching Copilot prompt and agent files instead of redefining command behavior.
|
|
27
|
+
- Dotted command names are preserved as canonical `devspec` vocabulary even when Claude invokes hyphenated skill names.
|
|
28
|
+
- Platform limitations belong in `devspec/adapters/compatibility-matrix.md`.
|
|
29
|
+
|
|
30
|
+
## Validation
|
|
31
|
+
|
|
32
|
+
Run the new repository, existing repository, story, and cross-tool recovery flows in `devspec/adapters/validation-flows.md` with Claude Code after installing or copying the project skills.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: devspec-workflow
|
|
3
|
+
description: Use when running any /devspec.* workflow from OpenAI Codex while preserving the canonical Copilot command and agent intent.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Devspec Workflow
|
|
7
|
+
|
|
8
|
+
Use this optional Codex skill as a starter template for repeated `devspec` workflows.
|
|
9
|
+
|
|
10
|
+
Before acting:
|
|
11
|
+
|
|
12
|
+
1. Read `AGENTS.md`.
|
|
13
|
+
2. Read `devspec/adapters/command-registry.md` for the requested `/devspec.*` command.
|
|
14
|
+
3. Read the canonical `.github/prompts/*.prompt.md` and `.github/agents/*.agent.md` files named by the registry.
|
|
15
|
+
4. Follow `AGENTS.md` for recovery, no-intent-drift, structured question behavior, and platform limitation handling.
|
|
16
|
+
|
|
17
|
+
Do not assume Copilot prompt files register as Codex slash commands. Treat the command name as workflow intent unless the active Codex surface provides its own matching command mechanism.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# OpenAI Codex Adapter
|
|
2
|
+
|
|
3
|
+
OpenAI Codex support starts with root `AGENTS.md`, which gives Codex the always-on repository instructions for the `devspec` workflow.
|
|
4
|
+
|
|
5
|
+
## Invocation Model
|
|
6
|
+
|
|
7
|
+
| Surface | Expected behavior |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `AGENTS.md` | Teaches Codex to treat `/devspec.*` as workflow intent and to use the command registry before acting. |
|
|
10
|
+
| Codex CLI or IDE extension | Users may type the canonical command name in a prompt, but Copilot prompt files are not assumed to register as Codex slash commands. |
|
|
11
|
+
| Codex skills | Optional starter template lives at `devspec/adapters/codex-skills/devspec-workflow/SKILL.md`; any installed skill must remain a thin wrapper over `devspec/adapters/command-registry.md`. |
|
|
12
|
+
|
|
13
|
+
## Adapter Rules
|
|
14
|
+
|
|
15
|
+
- Read `AGENTS.md` and `devspec/adapters/command-registry.md` before executing a `devspec` workflow.
|
|
16
|
+
- Preserve Copilot prompt and agent intent from the canonical files listed in the registry.
|
|
17
|
+
- Use Git-tracked `devspec` artifacts for recovery and handoff decisions.
|
|
18
|
+
- Treat Codex-specific slash commands, local/cloud modes, sandboxing, and approvals as platform mechanics, not workflow changes.
|
|
19
|
+
|
|
20
|
+
## Validation
|
|
21
|
+
|
|
22
|
+
Run the flow checklists in `devspec/adapters/validation-flows.md` with Codex local workflows before using Codex for enterprise delivery.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Devspec Command Registry
|
|
2
|
+
|
|
3
|
+
This registry is the provider-neutral contract for all `devspec` adapters. The GitHub Copilot prompt and agent files named here are the authoritative source for command intent. Adapter files may translate platform mechanics, but they must not change command purpose, required inputs, output artifacts, status values, gates, handoffs, or recovery behavior.
|
|
4
|
+
|
|
5
|
+
## Mutation Levels
|
|
6
|
+
|
|
7
|
+
| Level | Meaning |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `artifact-write` | May create or update `devspec/` artifacts only. |
|
|
10
|
+
| `code-write` | May edit target repository code when the upstream work item and repository access allow it. |
|
|
11
|
+
| `review-write` | May write review artifacts and report findings, but should not change implementation code. |
|
|
12
|
+
| `diagram-write` | May create or update Mermaid diagram artifacts and related queue state. |
|
|
13
|
+
|
|
14
|
+
## Registered Commands
|
|
15
|
+
|
|
16
|
+
| Command | Purpose | Required input | Canonical prompt | Canonical agent | Main outputs | Mutation level | Next handoff |
|
|
17
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
18
|
+
| `/devspec.extract` | Backfill project foundation, architecture context, constitution candidates, process-flow candidates, and diagram queue candidates from current root, repository URLs, local paths, or named multi-repo sources. | Optional source input; blank input triggers current-root or source selection. | `.github/prompts/devspec.extract.prompt.md` | `.github/agents/devspec.extract.agent.md` | `devspec/foundation/extraction-state.md`, `devspec/constitution.md`, `devspec/architecture/overview.md`, `devspec/architecture/artifact-queue.md`, live `devspec/foundation/*.md` | `artifact-write` | `/devspec.projectcontext` |
|
|
19
|
+
| `/devspec.projectcontext` | Capture product purpose, audiences, stakeholders, outcomes, scope boundaries, metrics, delivery context, sources, confidence, and developer implications. | Product context input. | `.github/prompts/devspec.projectcontext.prompt.md` | `.github/agents/devspec.projectcontext.agent.md` | `devspec/foundation/project-context.md` | `artifact-write` | `/devspec.techstack` |
|
|
20
|
+
| `/devspec.techstack` | Capture technology stack inventory, support status, evidence, confidence, delivery constraints, and implementation impact. | Stack evidence, target stack, hosting, tooling, or constraints. | `.github/prompts/devspec.techstack.prompt.md` | `.github/agents/devspec.techstack.agent.md` | `devspec/foundation/tech-stack.md` | `artifact-write` | `/devspec.codebase-structure` |
|
|
21
|
+
| `/devspec.codebase-structure` | Capture repository layout, work areas, boundaries, integration contracts, multi-repo configuration, and access requirements. | Repository layout, work-area, integration, or multi-repo details. | `.github/prompts/devspec.codebase-structure.prompt.md` | `.github/agents/devspec.codebase-structure.agent.md` | `devspec/foundation/codebase-structure.md` | `artifact-write` | `/devspec.coding-standards` |
|
|
22
|
+
| `/devspec.coding-standards` | Capture evidence-backed engineering standards, observed patterns, anti-patterns, source links, and examples. | Standards input, source links, or evidence to confirm. | `.github/prompts/devspec.coding-standards.prompt.md` | `.github/agents/devspec.coding-standards.agent.md` | `devspec/foundation/coding-standards.md` | `artifact-write` | `/devspec.rules` |
|
|
23
|
+
| `/devspec.rules` | Capture operational hard constraints, compliance requirements, forbidden patterns, delivery gates, exceptions, enforcement points, source, and confidence. | Rules, gates, governance, compliance, or constraint input. | `.github/prompts/devspec.rules.prompt.md` | `.github/agents/devspec.rules.agent.md` | `devspec/foundation/rules.md` | `artifact-write` | `/devspec.story` |
|
|
24
|
+
| `/devspec.story` | Create or update work-item intake artifacts from a provider URL, provider identifier, manual feature request, bug report, security issue, task, or PBI. | Work-item reference or manual intake details. | `.github/prompts/devspec.story.prompt.md` | `.github/agents/devspec.story.agent.md` | `devspec/work-items/<work-item-folder>/meta.md`, `story.md`, `decisions.md`, `notes.md` | `artifact-write` | `/devspec.clarify` if blocked; otherwise `/devspec.finalize` |
|
|
25
|
+
| `/devspec.clarify` | Ask, resolve, and record one active blocking clarification for an existing work item. | Existing work item with a recorded blocker or clarification need. | `.github/prompts/devspec.clarify.prompt.md` | `.github/agents/devspec.clarify.agent.md` | `devspec/work-items/<work-item-folder>/clarify.md` | `artifact-write` | Repeat until unblocked, then `/devspec.finalize` |
|
|
26
|
+
| `/devspec.finalize` | Create or update an implementation readiness brief with readiness assessment, implementation brief, validation plan, and blockers. | Existing upstream work-item artifacts. Optional additive readiness input. | `.github/prompts/devspec.finalize.prompt.md` | `.github/agents/devspec.finalize.agent.md` | `devspec/work-items/<work-item-folder>/finalize.md` | `artifact-write` | `/devspec.tasks` when ready |
|
|
27
|
+
| `/devspec.tasks` | Break a ready finalized brief into ordered executable implementation tasks with planning basis, validation, and done criteria. | `finalize.md` marked `ready`; optional task-planning input. | `.github/prompts/devspec.tasks.prompt.md` | `.github/agents/devspec.tasks.agent.md` | `devspec/work-items/<work-item-folder>/tasks.md` | `artifact-write` | `/devspec.implement` |
|
|
28
|
+
| `/devspec.implement` | Implement pending tasks for the current ready work item, update implementation checkpoints, and confirm after each task. | `finalize.md` marked `ready` and `tasks.md`; optional implementation or validation guidance. | `.github/prompts/devspec.implement.prompt.md` | `.github/agents/devspec.implement-task.agent.md` | `devspec/work-items/<work-item-folder>/implement.md`, code changes when applicable | `code-write` | `/devspec.review` when complete |
|
|
29
|
+
| `/devspec.review` | Review implemented work against the finalized brief and record review outcome. | `finalize.md` and `implement.md`; optional review focus. | `.github/prompts/devspec.review.prompt.md` | `.github/agents/devspec.review.agent.md` | `devspec/work-items/<work-item-folder>/review.md` | `review-write` | Return to `/devspec.implement` for changes or close the work item |
|
|
30
|
+
| `/devspec.diagram` | Generate or update one evidence-backed Mermaid diagram, or batch-generate queued process-flow diagrams when explicitly requested. | Diagram subject, related work item, or explicit process-flow batch request. | `.github/prompts/devspec.diagram.prompt.md` | `.github/agents/devspec.diagram.agent.md` | `devspec/architecture/diagrams/dia-NNN-*.md`, `devspec/architecture/overview.md` for high-level diagrams, or work-item `diagrams.md` for temporary work-item diagrams | `diagram-write` | Continue the current workflow |
|
|
31
|
+
|
|
32
|
+
## Required Flow Gates
|
|
33
|
+
|
|
34
|
+
| Flow | Command order | Acceptance signal |
|
|
35
|
+
| --- | --- | --- |
|
|
36
|
+
| New repository foundation | `/devspec.projectcontext` -> `/devspec.techstack` -> `/devspec.codebase-structure` -> `/devspec.coding-standards` -> `/devspec.rules` | Foundation artifacts exist, no extraction artifact is required, and each command records sources, confidence, blockers, and next action. |
|
|
37
|
+
| Existing repository foundation | `/devspec.extract` -> `/devspec.projectcontext` -> `/devspec.techstack` -> `/devspec.codebase-structure` -> `/devspec.coding-standards` -> `/devspec.rules` | Extraction evidence is recorded, foundation artifacts are refined, exclusions are respected, blockers are explicit, and confirmations are preserved. |
|
|
38
|
+
| Story lifecycle | `/devspec.story` -> optional `/devspec.clarify` -> `/devspec.finalize` -> `/devspec.tasks` -> `/devspec.implement` -> `/devspec.review` | Work-item artifacts exist, readiness is honored, tasks are executable, implementation ledger is current, validation evidence is recorded, and review status uses glossary values. |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Platform Compatibility Matrix
|
|
2
|
+
|
|
3
|
+
Use this matrix when adding or reviewing adapter support. A platform limitation must be documented here instead of changing `devspec` command semantics.
|
|
4
|
+
|
|
5
|
+
| Capability | GitHub Copilot in VS Code | Claude Code | OpenAI Codex | Cursor | Gemini CLI | Google Antigravity | Future adapters |
|
|
6
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
7
|
+
| Reference status | Reference implementation | Adapter | Adapter | Adapter | Adapter | Adapter | Adapter |
|
|
8
|
+
| Native command surface | `.github/prompts/*.prompt.md` registers `/devspec.*` prompt files. | `.claude/skills/*/SKILL.md` project skills expose command-like workflows. | `AGENTS.md` provides always-on guidance; Codex slash commands are tool-owned and should not be assumed to mirror Copilot prompt files. | `.cursor/rules/*.mdc` provides project rules; exact custom slash parity is not assumed. | `.gemini/commands/devspec/*.toml` provides `/devspec:*` project custom commands. | `.agents/skills/devspec-*.md` provides `/devspec-*` workspace skills. | Must map to `devspec/adapters/command-registry.md`. |
|
|
9
|
+
| Agent surface | `.github/agents/*.agent.md` with tools, model fallback, and handoffs. | Skills may run inline or through Claude subagents when configured. | Skills and app or CLI features may assist, but the repo contract starts from `AGENTS.md`. | Cursor Agent applies project rules and referenced files. | Gemini CLI applies context from `GEMINI.md` and command prompts. | Antigravity agents apply workspace rules, skills, permissions, artifacts, and project settings. | Must preserve command intent and artifact contracts. |
|
|
10
|
+
| Always-on repository guidance | Optional `.github/copilot-instructions.md` or prompt/agent context. | `CLAUDE.md` may be used by adopters; this framework ships skills instead of changing memory. | Root `AGENTS.md`. | Root `AGENTS.md` plus `.cursor/rules`. | Root `GEMINI.md` imports `AGENTS.md`. | `.agents/rules/devspec-workflow.md` plus `AGENTS.md` and `GEMINI.md` when supported. | Prefer `AGENTS.md` when supported. |
|
|
11
|
+
| MCP or external tools | Supported through Copilot and configured VS Code tools. | Supported through Claude Code MCP configuration. | Supported through Codex MCP configuration when enabled by the environment. | Supported through Cursor MCP configuration when enabled by the environment. | Supported through Gemini CLI settings or extensions when enabled. | Supported through Antigravity skills, plugins, and MCP configuration when enabled. | Provider integrations must remain outside prompt artifacts. |
|
|
12
|
+
| Approval and permissions | Governed by VS Code, Copilot, workspace trust, and selected tools. | Governed by Claude Code permissions and tool approvals. | Governed by Codex local, cloud, sandbox, and approval settings. | Governed by Cursor Agent permissions and workspace settings. | Governed by Gemini CLI trusted folders, sandboxing, and enterprise settings. | Governed by Antigravity project permissions, strict mode, sandboxing, and artifact review. | Must document permissions before write workflows. |
|
|
13
|
+
| Telemetry | Use tool-provided telemetry when available; otherwise record unavailable in artifacts. | Use available session, cost, or tool data when exposed. | Use available Codex status or analytics data when exposed. | Use available Cursor session signals when exposed. | Use Gemini CLI telemetry only when configured; otherwise record unavailable. | Use Antigravity session, artifact, or quota signals only when exposed; otherwise record unavailable. | Missing telemetry is recorded as unavailable, not invented. |
|
|
14
|
+
| Known gaps | None for the current reference workflow. | Exact dotted `/devspec.*` command names may depend on skill or command naming behavior. | Copilot prompt files do not automatically register as Codex slash commands. | Cursor rules guide behavior but do not guarantee slash-command registration. | Native commands use `/devspec:story`, not exact `/devspec.story`. | Native skills use `/devspec-story`; workflow files are not shipped until file contracts are confirmed. | Must be captured before enterprise rollout. |
|
|
15
|
+
|
|
16
|
+
## Compatibility Rules
|
|
17
|
+
|
|
18
|
+
- Keep command names and artifact contracts stable even when the host tool uses a different invocation surface.
|
|
19
|
+
- Prefer explicit user invocation for stage commands that write artifacts or code.
|
|
20
|
+
- Do not store credentials, tokens, personal settings, or provider secrets in adapter files.
|
|
21
|
+
- Record unsupported host features as platform gaps and continue to use the canonical `devspec` artifacts.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GitHub Copilot Adapter
|
|
2
|
+
|
|
3
|
+
GitHub Copilot in VS Code is the native and reference adapter for `devspec`.
|
|
4
|
+
|
|
5
|
+
## Reference Files
|
|
6
|
+
|
|
7
|
+
| File group | Role |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `.github/prompts/*.prompt.md` | Registers the user-invoked `/devspec.*` commands and command-level required input. |
|
|
10
|
+
| `.github/agents/*.agent.md` | Defines stage behavior, tools, model fallback, constraints, handoffs, and output format. |
|
|
11
|
+
| `.github/prompts/PATTERNS.md` | Defines shared workflow, recovery, output, discovery, recommendation, and artifact patterns. |
|
|
12
|
+
| `.github/skills/` | Optional reusable skills that travel with the repository. |
|
|
13
|
+
|
|
14
|
+
## Compatibility Note
|
|
15
|
+
|
|
16
|
+
Do not change Copilot prompt or agent intent to support another tool. Other adapters must wrap or translate the Copilot reference behavior and remain conformant with `devspec/adapters/command-registry.md`.
|
|
17
|
+
|
|
18
|
+
## Validation
|
|
19
|
+
|
|
20
|
+
Before an enterprise release, verify VS Code with Copilot Chat recognizes every registered `/devspec.*` command and run the flow checklists in `devspec/adapters/validation-flows.md`.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Cursor Adapter
|
|
2
|
+
|
|
3
|
+
Cursor support is implemented through project rules under `.cursor/rules/` and the shared root `AGENTS.md`.
|
|
4
|
+
|
|
5
|
+
## Invocation Model
|
|
6
|
+
|
|
7
|
+
| Surface | Expected behavior |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `.cursor/rules/devspec-workflow.mdc` | Provides project-scoped guidance for Cursor Agent and Inline Edit. |
|
|
10
|
+
| `AGENTS.md` | Provides a simple cross-agent fallback for `devspec` workflow behavior. |
|
|
11
|
+
| Chat prompt | Users may type canonical `/devspec.*` command names as workflow intent; exact slash registration is not assumed. |
|
|
12
|
+
|
|
13
|
+
## Adapter Rules
|
|
14
|
+
|
|
15
|
+
- Use `devspec/adapters/command-registry.md` for command order, required input, artifact outputs, mutation level, and handoff.
|
|
16
|
+
- Preserve GitHub Copilot prompt and agent intent from the canonical files named in the registry.
|
|
17
|
+
- Do not let Cursor-specific memories or user rules override Git-tracked `devspec` artifacts.
|
|
18
|
+
- Record unsupported Cursor behavior in `devspec/adapters/compatibility-matrix.md`.
|
|
19
|
+
|
|
20
|
+
## Validation
|
|
21
|
+
|
|
22
|
+
Run the new repository, existing repository, story, and cross-tool recovery flows in `devspec/adapters/validation-flows.md` before treating Cursor as enterprise-ready.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Enterprise Operating Guide
|
|
2
|
+
|
|
3
|
+
Use this guide when adopting `devspec` across teams, repositories, or AI coding tools.
|
|
4
|
+
|
|
5
|
+
## Governance Controls
|
|
6
|
+
|
|
7
|
+
| Area | Requirement |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| Model allowlist | Record approved models or model families per adapter. Do not require adapter files to name a model that the target platform cannot enforce. |
|
|
10
|
+
| Tool permissions | Define which adapters may read, edit, execute commands, use browsers, call MCP tools, or access external systems. |
|
|
11
|
+
| Repository access | Use `devspec/foundation/codebase-structure.md` as the source of truth for `reference-only`, `edit`, `edit-and-test`, `validation-only`, `release-coordination`, and `unavailable` access. |
|
|
12
|
+
| Secrets | Keep tokens, API keys, provider credentials, and local secrets outside prompt, agent, adapter, and artifact files. |
|
|
13
|
+
| Provider access | Use `devspec/foundation/provider-integrations.md` for supported providers, accepted formats, lookup behavior, manual fallback, and access expectations. |
|
|
14
|
+
| Audit evidence | Store decisions, readiness, tasks, implementation checkpoints, validation, and review outcomes in Git-tracked `devspec` artifacts. |
|
|
15
|
+
| Security work | Follow security-vulnerability handling rules from `devspec/foundation/rules.md` and avoid recording unsafe exploit detail unless explicitly approved. |
|
|
16
|
+
| Human approval | Require structured confirmation where the canonical prompt or agent contract requires it, especially provider resolution, repository access, constitution changes, and continuation after blockers. |
|
|
17
|
+
| Gemini CLI posture | Use trusted folders, sandboxing, `.geminiignore`, enterprise settings, and telemetry policy where available; keep Gemini extensions and MCP configuration outside prompt artifacts unless intentionally packaged. |
|
|
18
|
+
| Antigravity posture | Prefer strict mode or request-review settings for terminal commands, browser actions, MCP calls, non-workspace file access, and artifact application; keep projects scoped to recorded repositories. |
|
|
19
|
+
|
|
20
|
+
## Enterprise Rollout Gates
|
|
21
|
+
|
|
22
|
+
| Gate | Required evidence |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| Copilot baseline confirmed | Existing `.github/prompts` and `.github/agents` files remain unchanged in intent and still register the expected workflow in VS Code. |
|
|
25
|
+
| Adapter conformance confirmed | Each adapter maps to `devspec/adapters/command-registry.md` and records platform gaps in `devspec/adapters/compatibility-matrix.md`. |
|
|
26
|
+
| New repository flow passed | The new repository flow in `devspec/adapters/validation-flows.md` passes for the adapter. |
|
|
27
|
+
| Existing repository flow passed | The existing repository flow in `devspec/adapters/validation-flows.md` passes for the adapter. |
|
|
28
|
+
| Story flow passed | One feature, bug, or security work item completes intake through review. |
|
|
29
|
+
| Cross-tool recovery passed | A flow paused in one adapter resumes in another using only Git-tracked artifacts. |
|
|
30
|
+
|
|
31
|
+
## Operating Principles
|
|
32
|
+
|
|
33
|
+
- Keep the repository, not the AI session, as the durable source of truth.
|
|
34
|
+
- Prefer small, reviewable adapter changes over broad prompt rewrites.
|
|
35
|
+
- Add new adapters by mapping to the registry first, then validating with flow checklists.
|
|
36
|
+
- Treat compliance, security, production access, and external provider writes as explicit governance decisions.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Gemini CLI Adapter
|
|
2
|
+
|
|
3
|
+
Gemini CLI support is implemented through root `GEMINI.md` plus project custom commands under `.gemini/commands/devspec/`.
|
|
4
|
+
|
|
5
|
+
## Invocation Model
|
|
6
|
+
|
|
7
|
+
| Devspec command | Gemini CLI command |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `/devspec.extract` | `/devspec:extract` |
|
|
10
|
+
| `/devspec.projectcontext` | `/devspec:projectcontext` |
|
|
11
|
+
| `/devspec.techstack` | `/devspec:techstack` |
|
|
12
|
+
| `/devspec.codebase-structure` | `/devspec:codebase-structure` |
|
|
13
|
+
| `/devspec.coding-standards` | `/devspec:coding-standards` |
|
|
14
|
+
| `/devspec.rules` | `/devspec:rules` |
|
|
15
|
+
| `/devspec.story` | `/devspec:story` |
|
|
16
|
+
| `/devspec.clarify` | `/devspec:clarify` |
|
|
17
|
+
| `/devspec.finalize` | `/devspec:finalize` |
|
|
18
|
+
| `/devspec.tasks` | `/devspec:tasks` |
|
|
19
|
+
| `/devspec.implement` | `/devspec:implement` |
|
|
20
|
+
| `/devspec.review` | `/devspec:review` |
|
|
21
|
+
| `/devspec.diagram` | `/devspec:diagram` |
|
|
22
|
+
|
|
23
|
+
Gemini uses colon namespacing for project commands. Keep canonical dotted `/devspec.*` names in documentation and artifacts.
|
|
24
|
+
|
|
25
|
+
## Adapter Rules
|
|
26
|
+
|
|
27
|
+
- `GEMINI.md` imports `AGENTS.md` and adds only Gemini-specific guidance.
|
|
28
|
+
- Each TOML command is a thin wrapper around `devspec/adapters/command-registry.md`.
|
|
29
|
+
- Each TOML command names the matching Copilot prompt and agent files as the source of intent.
|
|
30
|
+
- Gemini CLI command arguments are passed through the native custom-command argument behavior.
|
|
31
|
+
- Do not use Gemini shell injection in devspec command wrappers; let the agent read files through normal tool access and approvals.
|
|
32
|
+
|
|
33
|
+
## Enterprise Safety
|
|
34
|
+
|
|
35
|
+
| Area | Guidance |
|
|
36
|
+
| --- | --- |
|
|
37
|
+
| Context hierarchy | Root `GEMINI.md` is the repository context file. Global `~/.gemini/GEMINI.md` may exist, but repository workflow rules should remain here. |
|
|
38
|
+
| Custom commands | Project commands live in `.gemini/commands/devspec/` and should be version-controlled with the framework. |
|
|
39
|
+
| Extensions | Gemini extensions can package prompts, MCP servers, and commands, but this repository ships project commands first for reviewability. |
|
|
40
|
+
| Enterprise configuration | Organization-wide Gemini CLI settings should enforce approved auth, tool access, and MCP policy outside prompt artifacts. |
|
|
41
|
+
| Sandboxing | Prefer sandboxing or command approval for validation and implementation workflows, especially outside trusted folders. |
|
|
42
|
+
| Telemetry | Use Gemini CLI telemetry only when configured by the environment; otherwise record token or telemetry data as unavailable. |
|
|
43
|
+
| Trusted folders | Treat repository trust as a prerequisite before allowing write or execute workflows. |
|
|
44
|
+
| Ignore rules | Use `.geminiignore` in consuming repositories when generated files, secrets, or large local folders need exclusion. |
|
|
45
|
+
|
|
46
|
+
## Known Gaps
|
|
47
|
+
|
|
48
|
+
- Gemini CLI custom commands use `/devspec:story` style names, not exact `/devspec.story` names.
|
|
49
|
+
- Copilot prompt files do not automatically register as Gemini commands.
|
|
50
|
+
- Exact permission, sandbox, and telemetry behavior depends on the user's Gemini CLI configuration.
|
|
51
|
+
|
|
52
|
+
## Validation
|
|
53
|
+
|
|
54
|
+
Run the new repository, existing repository, story, and cross-tool recovery flows in `devspec/adapters/validation-flows.md` with Gemini CLI before treating the adapter as enterprise-ready.
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Enterprise Validation Flows
|
|
2
|
+
|
|
3
|
+
Use these flows as release gates for multi-agent support. Run them per adapter before declaring the adapter enterprise-ready.
|
|
4
|
+
|
|
5
|
+
## New Repository Flow
|
|
6
|
+
|
|
7
|
+
Validate the foundation path for a repository with little or no implementation code.
|
|
8
|
+
|
|
9
|
+
| Step | Command | Expected evidence |
|
|
10
|
+
| --- | --- | --- |
|
|
11
|
+
| 1 | `/devspec.projectcontext` | `devspec/foundation/project-context.md` captures product purpose, users, outcomes, scope boundaries, sources, confidence, and developer implications. |
|
|
12
|
+
| 2 | `/devspec.techstack` | `devspec/foundation/tech-stack.md` captures stack choices, support status, hosting or tooling constraints, sources, and confidence. |
|
|
13
|
+
| 3 | `/devspec.codebase-structure` | `devspec/foundation/codebase-structure.md` captures planned or existing layout, work areas, integration boundaries, and repository access expectations. |
|
|
14
|
+
| 4 | `/devspec.coding-standards` | `devspec/foundation/coding-standards.md` captures implementation standards, testing expectations, observed or selected patterns, and blockers. |
|
|
15
|
+
| 5 | `/devspec.rules` | `devspec/foundation/rules.md` captures operational rules, compliance requirements, delivery gates, and work-item handling rules. |
|
|
16
|
+
|
|
17
|
+
Acceptance checklist:
|
|
18
|
+
|
|
19
|
+
- No extraction step is required.
|
|
20
|
+
- Every generated artifact uses its live foundation file, not the `_template` file as the final output.
|
|
21
|
+
- Every command records blockers or confidence gaps instead of guessing.
|
|
22
|
+
- The next recommended action follows `devspec/adapters/command-registry.md`.
|
|
23
|
+
|
|
24
|
+
## Existing Repository Flow
|
|
25
|
+
|
|
26
|
+
Validate the foundation path for a repository or multi-repo system that already contains implementation evidence.
|
|
27
|
+
|
|
28
|
+
| Step | Command | Expected evidence |
|
|
29
|
+
| --- | --- | --- |
|
|
30
|
+
| 1 | `/devspec.extract` | `devspec/foundation/extraction-state.md`, `devspec/architecture/overview.md`, `devspec/architecture/artifact-queue.md`, and live foundation artifacts are seeded from evidence. |
|
|
31
|
+
| 2 | `/devspec.projectcontext` | Product context is refined with human business context that code cannot fully prove. |
|
|
32
|
+
| 3 | `/devspec.techstack` | Extracted stack evidence is confirmed or corrected. |
|
|
33
|
+
| 4 | `/devspec.codebase-structure` | Repository layout, work areas, multi-repo access, and boundaries are confirmed. |
|
|
34
|
+
| 5 | `/devspec.coding-standards` | Evidence-backed coding standards and anti-patterns are confirmed. |
|
|
35
|
+
| 6 | `/devspec.rules` | Operational and compliance rules are confirmed or added. |
|
|
36
|
+
|
|
37
|
+
Acceptance checklist:
|
|
38
|
+
|
|
39
|
+
- Discovery exclusions from `devspec/foundation/discovery-exclusions.md` are respected.
|
|
40
|
+
- Extraction does not rewrite `devspec/constitution.md` principles from code inference without confirmation.
|
|
41
|
+
- Missing evidence, access issues, and unresolved provider lookup paths are recorded as blockers.
|
|
42
|
+
- Extracted facts are placed in their target artifacts, not left only in extraction notes.
|
|
43
|
+
|
|
44
|
+
## End-To-End Story Flow
|
|
45
|
+
|
|
46
|
+
Validate one full feature, bug, or security-vulnerability lifecycle after the foundation exists.
|
|
47
|
+
|
|
48
|
+
| Step | Command | Expected evidence |
|
|
49
|
+
| --- | --- | --- |
|
|
50
|
+
| 1 | `/devspec.story` | `meta.md`, `story.md`, `decisions.md`, and `notes.md` exist under one valid work-item folder. |
|
|
51
|
+
| 2 | `/devspec.clarify` when blocked | `clarify.md` records the active question, answer, resolution, and remaining blockers. |
|
|
52
|
+
| 3 | `/devspec.finalize` | `finalize.md` records readiness, implementation brief, validation plan, assumptions, and blockers. |
|
|
53
|
+
| 4 | `/devspec.tasks` | `tasks.md` records executable tasks with repository, target area, validation, done criteria, dependencies, and status. |
|
|
54
|
+
| 5 | `/devspec.implement` | `implement.md` records repository access checks, task ledger, attempts, changed files or areas, validation results, blockers, and resume state. |
|
|
55
|
+
| 6 | `/devspec.review` | `review.md` records findings, scope adherence, validation gaps, rule violations, and review status. |
|
|
56
|
+
|
|
57
|
+
Acceptance checklist:
|
|
58
|
+
|
|
59
|
+
- Work-item state uses values from `devspec/glossary.md`.
|
|
60
|
+
- `finalize.md` must be `ready` before `/devspec.tasks` plans implementation tasks.
|
|
61
|
+
- `/devspec.tasks` does not expand scope beyond the finalized brief.
|
|
62
|
+
- `/devspec.implement` respects repository access requirements from `devspec/foundation/codebase-structure.md`.
|
|
63
|
+
- `/devspec.review` reviews against the finalized brief instead of re-planning.
|
|
64
|
+
|
|
65
|
+
## Cross-Tool Recovery Scenario
|
|
66
|
+
|
|
67
|
+
Use this scenario to prove the framework is tool-neutral.
|
|
68
|
+
|
|
69
|
+
1. Start the new repository flow, existing repository flow, or story flow in one supported adapter.
|
|
70
|
+
2. Stop after a command writes a `Resume State` or workflow checkpoint.
|
|
71
|
+
3. Open the same repository in another supported adapter.
|
|
72
|
+
4. Ask the adapter to continue the same registered command or next handoff.
|
|
73
|
+
5. Confirm it reads Git-tracked `devspec` artifacts first and continues from the recorded checkpoint.
|
|
74
|
+
|
|
75
|
+
Acceptance checklist:
|
|
76
|
+
|
|
77
|
+
- The second adapter does not rely on the first adapter's chat history.
|
|
78
|
+
- The second adapter preserves pending questions, blockers, current task, and next action.
|
|
79
|
+
- Any unsupported platform feature is recorded as a limitation, not converted into a workflow change.
|
|
80
|
+
|
|
81
|
+
## Adapter Wrapper Checks
|
|
82
|
+
|
|
83
|
+
Run these checks before enterprise release:
|
|
84
|
+
|
|
85
|
+
| Adapter | Required wrapper evidence |
|
|
86
|
+
| --- | --- |
|
|
87
|
+
| Gemini CLI | Root `GEMINI.md` exists; `.gemini/commands/devspec/*.toml` has one wrapper for each registered command; native command names map `/devspec.story` to `/devspec:story` style names. |
|
|
88
|
+
| Google Antigravity | `.agents/rules/devspec-workflow.md` exists; `.agents/skills/devspec-*.md` has one wrapper for each registered command; native skill names map `/devspec.story` to `/devspec-story` style names. |
|
|
89
|
+
|
|
90
|
+
Each wrapper must reference `devspec/adapters/command-registry.md` and the matching canonical Copilot prompt and agent files.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Architecture Diagram Queue
|
|
2
|
+
|
|
3
|
+
Use this file as the resumable queue register for proposed and generated architecture diagrams. Keep generated diagram content in the target artifact; keep only queue metadata, evidence, confidence, status, and next action or notes here.
|
|
4
|
+
|
|
5
|
+
Store high-level diagrams in `devspec/architecture/overview.md`, durable detailed diagrams in `devspec/architecture/diagrams/dia-NNN-<diagram-name>.md`, and temporary work-item diagrams in `devspec/work-items/<work-item-folder>/diagrams.md`.
|
|
6
|
+
|
|
7
|
+
## Diagram Queue Register
|
|
8
|
+
|
|
9
|
+
Add rows only when extraction or `/devspec.diagram` identifies real diagram candidates backed by evidence. Keep one row per diagram subject and update the existing row instead of creating duplicates.
|
|
10
|
+
|
|
11
|
+
| ID | Scope | Diagram type | Subject | Target location | Evidence | Confidence | Status | Tags | Next action or notes |
|
|
12
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
13
|
+
|
|
14
|
+
## Queue Field Definitions
|
|
15
|
+
|
|
16
|
+
| Field | Guidance |
|
|
17
|
+
| --- | --- |
|
|
18
|
+
| ID | Use stable IDs such as `DIA-001`, preserving existing IDs and assigning the next available number for new rows. |
|
|
19
|
+
| Scope | Use `architecture`, `module`, `feature`, `workflow`, `user-journey`, or `work-item`. Prefer durable scopes over `work-item` unless the diagram is explicitly temporary or work-item-specific. |
|
|
20
|
+
| Diagram type | Use the Mermaid family only: `flowchart`, `sequenceDiagram`, `journey`, `stateDiagram`, `classDiagram`, or `erDiagram`. Do not include orientation here. |
|
|
21
|
+
| Subject | Use a specific lowercase kebab-case subject that can map to one diagram file or one overview section. For queued architecture diagrams, prefix the subject with the lowercase queue ID, such as `dia-001-order-fulfillment-flow`. |
|
|
22
|
+
| Target location | Use `devspec/architecture/overview.md#diagram-reference-index` for high-level overview diagrams, `devspec/architecture/diagrams/dia-NNN-<diagram-name>.md` for durable detailed diagrams, or `devspec/work-items/<work-item-folder>/diagrams.md#diagram-content` for temporary work-item diagrams. |
|
|
23
|
+
| Evidence | Name the source paths, docs, ADRs, queue request, or user-confirmed basis supporting the candidate. |
|
|
24
|
+
| Confidence | Use `observed` for direct evidence, `high-confidence` for inference from multiple local evidence points, or `low-confidence` when useful but incomplete evidence needs assumptions before generation. |
|
|
25
|
+
| Status | Use `devspec/glossary.md#artifact-status-values`; queue status belongs here, not in diagram indexes or generated diagram content. |
|
|
26
|
+
| Tags | Use comma-separated lowercase tags such as `process-flow`, `business-process`, `user-journey`, `lifecycle-flow`, or `hybrid-user-to-data-operational-flow` when they apply. Leave blank only when no durable selection tag is useful. |
|
|
27
|
+
| Next action or notes | Record duplicate-check result, suggested Mermaid declaration such as `flowchart LR` or `sequenceDiagram`, assumptions, blocker details, skip reason, or the next action needed. |
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Architecture Decision
|
|
2
|
+
|
|
3
|
+
Use this artifact for one durable architecture decision that affects multiple work items, long-lived system structure, integration boundaries, technology direction, or operational architecture. Create ADR files under `devspec/architecture/decisions/` only when the user explicitly asks or the decision has clear supporting evidence and needs durable cross-work-item tracking.
|
|
4
|
+
|
|
5
|
+
## Decision Metadata
|
|
6
|
+
|
|
7
|
+
| Field | Value |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| ID | ADR-0000 |
|
|
10
|
+
| Title | |
|
|
11
|
+
| Status | proposed, accepted, superseded |
|
|
12
|
+
| Date | |
|
|
13
|
+
| Decision owner | |
|
|
14
|
+
| Supersedes | ADR ID or none |
|
|
15
|
+
|
|
16
|
+
## Decision Context
|
|
17
|
+
|
|
18
|
+
Use this section for the problem, forces, constraints, and alternatives that explain why a durable architecture decision is needed. Keep implementation task details in work-item artifacts.
|
|
19
|
+
|
|
20
|
+
| Context item | Details | Evidence |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| Problem or driver | | |
|
|
23
|
+
| Constraints or forces | | |
|
|
24
|
+
| Alternatives considered | | |
|
|
25
|
+
|
|
26
|
+
## Decision Outcome
|
|
27
|
+
|
|
28
|
+
| Field | Value |
|
|
29
|
+
| --- | --- |
|
|
30
|
+
| Decision statement | |
|
|
31
|
+
| Scope | |
|
|
32
|
+
| Rationale | |
|
|
33
|
+
|
|
34
|
+
## Impact and References
|
|
35
|
+
|
|
36
|
+
Use this section for the decision effects and durable links that future agents or developers must preserve. Link related work-item decisions instead of duplicating them here.
|
|
37
|
+
|
|
38
|
+
| Type | Item | Required handling or relationship |
|
|
39
|
+
| --- | --- | --- |
|
|
40
|
+
| positive consequence | | |
|
|
41
|
+
| trade-off | | |
|
|
42
|
+
| risk | | |
|
|
43
|
+
| related work item | | |
|
|
44
|
+
| related architecture artifact | | |
|
|
45
|
+
| source evidence | | |
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Architecture Diagram
|
|
2
|
+
|
|
3
|
+
Use this artifact for one durable architecture, module, feature, workflow, process-flow, user journey, sequence, state, or domain diagram. Keep diagram status in `devspec/architecture/artifact-queue.md`; keep only generated content, supporting evidence, assumptions, and maintenance notes here.
|
|
4
|
+
|
|
5
|
+
## Resume State
|
|
6
|
+
|
|
7
|
+
| Field | Value |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| Current stage | diagram |
|
|
10
|
+
| Current command | `/devspec.diagram` |
|
|
11
|
+
| Current agent | devspec.diagram |
|
|
12
|
+
| Run status | See `devspec/glossary.md#run-status-values` |
|
|
13
|
+
| Current item | |
|
|
14
|
+
| Last completed step | |
|
|
15
|
+
| Next required action | |
|
|
16
|
+
| Pending user question | |
|
|
17
|
+
| Recommended option | |
|
|
18
|
+
| Resume command | `/devspec.diagram` |
|
|
19
|
+
| Resume notes | |
|
|
20
|
+
| Updated | |
|
|
21
|
+
|
|
22
|
+
## Diagram Metadata
|
|
23
|
+
|
|
24
|
+
| Field | Value |
|
|
25
|
+
| --- | --- |
|
|
26
|
+
| ID | |
|
|
27
|
+
| Display title | `DIA-NNN - <Title Case Diagram Name>` |
|
|
28
|
+
| Scope | architecture, module, feature, workflow, user-journey |
|
|
29
|
+
| Diagram type | flowchart, sequenceDiagram, journey, stateDiagram, classDiagram, erDiagram |
|
|
30
|
+
| Mermaid declaration | flowchart TD, flowchart LR, flowchart BT, sequenceDiagram, journey, stateDiagram-v2, classDiagram, erDiagram |
|
|
31
|
+
| Subject | `dia-NNN-<diagram-name>` |
|
|
32
|
+
| Confidence | observed, high-confidence, low-confidence |
|
|
33
|
+
| Tags | |
|
|
34
|
+
| Queue row | `devspec/architecture/artifact-queue.md#diagram-queue-register` |
|
|
35
|
+
|
|
36
|
+
## Mermaid Diagram
|
|
37
|
+
|
|
38
|
+
- Keep durable `DIA-*` IDs and `dia-NNN-*` subjects in metadata and filenames only; Mermaid content uses simple internal naming.
|
|
39
|
+
- Use short alphanumeric node IDs, double-quoted node labels of 1-4 words, and 2-3 word edge labels. Do not use `\n` or `<br>` inside node labels or edge labels.
|
|
40
|
+
- Keep architectural flowcharts focused on one primary domain at macro level, structurally unidirectional, and adjacent by layer. Do not include overloaded graphs, cross-layer arrows, decision diamonds, UI micro-interactions, or return/error paths unless the diagram is explicitly an algorithm or activity flowchart.
|
|
41
|
+
- Use `sequenceDiagram` for exact step-by-step request and response behavior. Sequence diagrams should show happy-path messages between distinct participants, collapse pass-through API client helpers, and use method names for message labels.
|
|
42
|
+
- Keep runtime communication and compile-time project dependencies in separate diagrams. Logical architecture diagrams exclude SDLC actors and build artifacts, and keep owned application databases inside the system boundary.
|
|
43
|
+
- Avoid API, Swagger, tech stack, version, library, hosting, and framework boilerplate details in flowchart nodes unless the diagram is specifically about startup, request-pipeline, infrastructure-layer, or physical deployment behavior.
|
|
44
|
+
|
|
45
|
+
```mermaid
|
|
46
|
+
flowchart TD
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Source Evidence and Assumptions
|
|
50
|
+
|
|
51
|
+
Use `evidence` for directly supported code, docs, config, ADRs, or user-confirmed facts. Use `assumption` only when the diagram depends on an inference that is not fully confirmed.
|
|
52
|
+
|
|
53
|
+
| Type | Source or assumption | Diagram impact | Resolution |
|
|
54
|
+
| --- | --- | --- | --- |
|
|
55
|
+
| evidence | | | confirmed |
|
|
56
|
+
| assumption | | | open |
|
|
57
|
+
|
|
58
|
+
## Maintenance Notes
|
|
59
|
+
|
|
60
|
+
| Note | Action or owner | Resolution state |
|
|
61
|
+
| --- | --- | --- |
|
|
62
|
+
| | | open |
|