[Feature]: Move bug workflow artifacts to a configurable docs/speckit/bugs root through staged migration
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 30/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- github, python
调研方向
Start with extensions/bug/README.md and trace how the assess, fix, and test stages select BUG_DIR, read and write reports, and check prerequisites. The issue calls for coordinated changes across extension instructions, configuration, migration, hooks, documentation, and tests; first map those entry points and existing configuration conventions. Done means the staged rollout and acceptance criteria are covered, including legacy compatibility, custom roots, migration conflicts, and workflow continuity.
由索引模型根据 Issue 内容生成。
描述
Problem and rationale
The bundled bug extension stores authored bug reports under .specify/bugs/<slug>/, mixing workflow evidence with tooling/configuration.
Align with github/spec-kit#5037 (https://github.com/github/spec-kit/issues/5037): keep tooling/configuration in .specify/ and authored workflow artifacts under a clearly owned documentation hierarchy. Bug artifacts remain distinct from SDD and idea-assessment artifacts. Parallel assessment tracking: github/spec-kit#5039 (https://github.com/github/spec-kit/issues/5039).
Proposed solution
Introduce explicit opt-in to a configurable bug artifact root, defaulting in the new layout to:
docs/speckit/bugs/<slug>/
assessment.md
fix.md
test.md
The bug extension owns selection and migration; core must not acquire bug-specific knowledge merely to enforce a directory convention. Support an environment root override, provisionally SPECIFY_BUGS_DIR, subject to existing configuration conventions. Define project-level layout selection and environment/project/default precedence so absent environment variables do not redirect ongoing workflows. Do not automatically persist transient overrides. Relative roots resolve against the Spec Kit project root.
Apply one resolved root consistently across assess/fix/test, slug uniqueness, prerequisites, reads/writes, hook context (BUG_DIR), and completion/handoff references. Preserve recorded paths and ongoing workflow selection rather than silently rebasing them under changed configuration.
Migration is explicit and preserves authored content. Competing copies of the same slug must cause an actionable conflict, not arbitrary selection, merging, overwriting, or duplicate workflows. Preserve existing stage semantics, source-editing restrictions, overwrite confirmation, and applicable path-safety guarantees.
Four-stage rollout
- Opt-in: Support unified/custom roots while retaining
.specify/bugs/defaults for non-opted-in projects. - Deprecation warnings: Warn on the legacy root with actionable migration guidance, without moving files or changing behavior.
- Default flip with legacy opt-out: Default new adoption to
docs/speckit/bugs/; preserve explicit legacy compatibility for existing projects and in-progress bugs. - Removal: Retire legacy-root support after an adequate announced transition period. Detect unmigrated workflows and provide migration errors rather than missing-report errors or duplicate artifact creation.
Do not assign specific release versions. Consecutive PRs are not a compatibility window; allow release/adoption time. The extension can progress independently of core and assessment rollouts.
Acceptance criteria
- Initial opt-in preserves legacy defaults unless explicitly selected.
- Opted-in defaults use
docs/speckit/bugs/<slug>/; an environment override can relocate the root. - Selection, persistence, precedence, existing-project detection, and project-relative path resolution are explicit across commands.
- Invalid configuration produces actionable errors rather than silent fallback.
- Assess/fix/test, prerequisites, slug collision checks, hooks, and report references use the same selected root.
- Existing reports, recorded paths, and in-progress stage selection remain coherent across upgrades/configuration changes.
- Migration is explicit and preserves content; duplicate slugs across roots are surfaced without silent precedence or overwrites.
- Existing stage semantics, source-code editing restrictions, overwrite protection, and applicable path-safety guarantees remain intact.
- 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 roots, collisions, and workflow continuity.
- Extension instructions, documentation, examples, hook guidance, and directly related references are updated together.
- The staged transition allows adequate announced adoption time without committing to specific versions.
Alternatives and scope
Keeping .specify/bugs/ avoids migration but leaves authored evidence mixed with tooling. Implementing extension paths in core or adding a shared parent-directory variable introduces unnecessary coupling. Environment-only selection and automatic moves risk broken ongoing work and duplicates.
This is a separate tracking issue, not an expansion of the core SDD implementation or an all-stages PR. The existing contract is documented in extensions/bug/README.md, including the three artifact names and hook reuse of BUG_DIR. All agents are affected.
Replaces the mistakenly filed fork issue https://github.com/mnriem/spec-kit/issues/59, 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 天内回复