github / github/spec-kit

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

オープン 初心者向け
#4,119 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Python
スター
137k
フォーク
12.3k
平均マージ
2日 12時間
マージ済み PR(30日)
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.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Start at the README's Get Started section and check whether a fuller example already exists in the docs or examples directory. Add a small end-to-end example covering a spec or PRD fragment, the command or template used, and the resulting artifact for an AI coding agent, or link to an existing example; done means newcomers can follow the workflow without the blank-page problem.

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
72/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。