github / github/spec-kit

Add a tiny end-to-end example to README/docs

未关闭 适合新手
#4,119 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
137k
派生
12.3k
平均合并
2 天 12 小时
30 天内合并 PR
159

描述

I was looking through Spec Kit and the tagline “Define what to build before building it — with any AI coding agent” makes the goal clear, but I had a little trouble forming a mental model of the actual workflow from the README alone.

It would help newcomers to include a very small example near the Get Started section: a short spec file or PRD fragment, the command/template used to process it, and what the next artifact looks like when handed to an agent like Copilot. Even a contrived example like “add a /health endpoint” would make the boundaries clearer.

If a fuller example already lives in docs or an examples directory, a direct link from the README would still be useful. The main benefit is reducing the blank-page problem for people trying to map spec-driven development onto their own repo.

贡献指南

打开贡献指南

调研方向

从 README 的 Get Started 部分开始,检查文档或 examples 目录中是否已经存在更完整的示例。添加一个小型端到端示例,涵盖 spec 或 PRD 片段、所使用的 command 或 template,以及为 AI coding agent 生成的 artifact;或者链接到现有示例。当新手无需面对 blank-page problem 就能按照 workflow 操作时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
冷清
描述清晰度
基本清楚
新手友好度
72/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。