[Feature]: Move assessment artifacts to a configurable docs/speckit/assessments root through staged migration
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
研究方向
Start with extensions/assess/README.md, which the issue identifies as documenting current artifact names, slug reuse, refinement, handoff, and path safety. Trace how intake, research, define, shape, and decide select roots and handle prerequisites, then map those paths to the acceptance criteria. Done means staged opt-in, migration, compatibility, and removal behavior are covered across the workflow without breaking the listed contracts.
由索引模型根據 Issue 內容生成。
描述
Problem and rationale
The bundled assess extension stores authored idea-assessment artifacts under .specify/assessments/<slug>/, mixing discovery evidence and decisions with tooling/configuration.
Align with github/spec-kit#5037 (https://github.com/github/spec-kit/issues/5037): .specify/ holds tooling/configuration and docs/speckit/ provides a consistent authored-artifact hierarchy. Assessments remain a distinct discovery workflow, separate from SDD delivery and bug assessments. Parallel bug tracking: github/spec-kit#5038 (https://github.com/github/spec-kit/issues/5038).
Proposed solution
Introduce explicit opt-in to a configurable assessment artifact root, defaulting in the new layout to:
docs/speckit/assessments/<slug>/
intake.md
research.md
problem.md
concept.md
decision.md
The assessment extension owns selection and migration. Support an environment root override, provisionally SPECIFY_ASSESSMENTS_DIR, subject to existing conventions. Define project-level layout selection and environment/project/default precedence so absent environment overrides do not accidentally redirect later stages. Do not automatically persist transient overrides. Relative paths resolve against the Spec Kit project root.
Apply one resolved root consistently across intake/research/define/shape/decide, prerequisites, slug uniqueness/context reuse, artifact references/refinement, and decision-to-SDD handoff. Preserve recorded paths and ongoing workflow selection rather than silently rebasing them under changed configuration.
Migration is explicit and preserves content. Competing assessment copies cause a conflict, not arbitrary precedence, automatic merging, or overwrites. Preserve discovery stage prerequisites, evidence/verdict requirements, empty-project support, and optional forward handoff to SDD. Relocation must not introduce automatic SDD execution or couple discovery to SDD layout selection.
Four-stage rollout
- Opt-in: Add unified/custom roots while retaining
.specify/assessments/defaults for non-opted-in projects. - Deprecation warnings: Warn on the legacy root with actionable migration guidance; no file moves or behavior changes.
- Default flip with legacy opt-out: Default new adoption to
docs/speckit/assessments/; preserve explicit compatibility for existing projects and in-progress assessments. - Removal: Retire legacy-root support after an adequate announced transition period. Unmigrated assessments receive migration errors instead of missing-prerequisite errors or duplicate artifacts.
Do not assign specific release versions. PR boundaries alone are not compatibility windows; allow release/adoption time. Assessment, bug, and core rollouts may progress independently.
Acceptance criteria
- Initial opt-in preserves legacy defaults unless explicitly selected.
- Opted-in defaults use
docs/speckit/assessments/<slug>/; an environment override relocates the root. - Layout selection, persistence, precedence, existing-project detection, and project-relative resolution are explicit across all five commands.
- Invalid configuration produces actionable errors rather than silent fallback.
- All artifact reads/writes, prerequisites, slug collision checks, context reuse, refinement, and handoff references use the selected root.
- Existing assessments, recorded paths, and ongoing stage selection remain coherent across upgrades/configuration changes.
- Migration is explicit and preserves content; conflicts across roots are reported without silent precedence or overwrites.
- Source-code write restrictions, overwrite protection, and path-safety guarantees remain intact, including symlink-component rejection and project containment for custom roots.
- Stage prerequisites, evidence/verdict rules, empty-project support, and deliberate optional SDD handoff remain unchanged.
- Warnings do not change behavior; default flip retains documented legacy opt-out; removal reports clear migration errors.
- Positive and negative coverage demonstrates legacy compatibility, opt-in/custom roots, absent overrides, invalid/unsafe roots, conflicts, and pipeline continuity.
- Extension instructions, documentation, examples, handoff guidance, and directly related references are updated together.
- Stages provide adequate announced adoption time without committing to specific versions.
Alternatives and scope
Keeping .specify/assessments/ avoids migration but not separation of authored artifacts from tooling. Putting discovery inside the SDD root blurs discovery/delivery. Core-owned extension paths or a mandatory shared parent variable unnecessarily couple independently configurable workflows. Environment-only selection and automatic moves risk broken continuity and duplicates.
This is a separate staged tracking issue, not an all-stages PR or a requirement to share implementation/release schedules with core and bug work.
extensions/assess/README.md documents current artifact names, slug reuse, explicit artifact refinement, optional decision.md handoff, and symlink rejection/project containment. Relocation must preserve those contracts. All agents are affected.
Replaces the mistakenly filed fork issue https://github.com/mnriem/spec-kit/issues/60, with the user's authorization.
AI disclosure
Drafted and filed on behalf of @mnriem using GitHub Copilot App, powered by GPT-6.1 Sol (gpt-6.1-sol), in human-supervised interactive mode. The agent inspected the bundled README and drafted the rationale, rollout, and acceptance criteria from the user-approved discussion. The user authorized upstream filing. Reasoning-effort setting was not available to report. No implementation changes were made.
- 主要語言
- Python
- 星號
- 149k
- 分支
- 13.4k
- 平均合併
- 1 天 5 小時
- 30 天內合併 PR
- 223
環境準備
在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
github/spec-kit 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 68/100
維護者通常 1 天內回覆
-
triage-must-have
難度 1/5 1 小時以內 新手友好度 78/100
維護者通常 1 天內回覆
-
Workflow-step verifier test fixture breaks when the checkout path contains whitespace (4 failures on macOS)可能已有人在做 @mehdikarimi55 於 3 天前認領。 未關閉triage-can-wait
難度 2/5 1-3 小時 新手友好度 83/100
維護者通常 1 天內回覆
-
Parity tests fail under the documented direct pytest invocation when the ambient python3 lacks PyYAML (11 failures)可能已有人在做 @mehdikarimi55 於 3 天前認領。 未關閉triage-must-have
難度 2/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆
-
bug triage-out-of-scope
難度 2/5 1-3 小時 新手友好度 64/100
維護者通常 1 天內回覆
相似的 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 80/100
glossyio/traffic-monitor#312 ·
維護者通常 1 天內回覆
-
documentation enhancement
難度 2/5 1-3 小時 新手友好度 76/100
es-ude/elastic-ai.creator#1046 ·
維護者通常 3 天內回覆
-
feature request
難度 2/5 1-3 小時 新手友好度 65/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
confident-ai/deepteam#306 ·
維護者通常 1 天內回覆
-
SslLibrary crashes with unhandled OSError: port/proto not found on non-standard SSL ports可能已有人在做 @himanchalkaushale 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 82/100
OWASP/Nettacker#1884 · 1 則留言 ·
維護者通常 1 天內回覆