Add a tiny end-to-end example to README/docs
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 72/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Ambito
- documentation
Direzione di ricerca
Inizia dalla sezione Get Started del README e verifica se esiste già un esempio più completo nella documentazione o nella directory examples. Aggiungi un piccolo esempio end-to-end che includa un frammento di spec o PRD, il comando o template utilizzato e l’artefatto risultante per un AI coding agent, oppure collega un esempio esistente; il lavoro è completato quando i nuovi arrivati possono seguire il workflow senza il problema della pagina vuota.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 138k
- Fork
- 12.4k
- Merge medio
- 3g 6h
- PR unite (30g)
- 145
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/spec-kit
-
enhancement needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
enhancement needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
-
enhancement needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
-
enhancement needs-triage triage-can-wait
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
Tutte le issue di github/spec-kit
Issue simili
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
canonical/paas-charm#368 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
tech debt
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
addition to tracking list Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
StevenBlack/hosts#3256 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
qualcomm/qai-appbuilder#275 ·