Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta Para iniciantes
  • Algo errado?
#4,119 4 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Pouca atividade
Domínio
documentation

Direção de pesquisa

Comece pela seção Get Started do README e verifique se já existe um exemplo mais completo na documentação ou no diretório examples. Adicione um pequeno exemplo de ponta a ponta cobrindo um fragmento de spec ou PRD, o comando ou template usado e o artefato resultante para um AI coding agent, ou faça um link para um exemplo existente; considera-se concluído quando pessoas novas no projeto conseguem seguir o workflow sem o problema da página em branco.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Python
Estrelas
140k
Forks
12.6k
Merge médio
2d 11h
PRs com merge (30d)
186

Preparar o ambiente

Abrir no Codespaces

Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de github/spec-kit

Todas as issues de github/spec-kit

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.