Lição 4
Templates de README e issue
Rascunhe README, changelogs e templates de issue com estrutura clara e seções reutilizáveis.
Markdown vale mais quando segue formas de documento previsíveis.
Estrutura de README
Um README open source prático costuma incluir:
# Nome do projeto
Resumo em uma linha.
## Recursos
- Recurso A
- Recurso B
## Início rápido
```bash
npm install
npm run dev
Configuração
Explique variáveis de ambiente ou arquivos de config.
Licença
MIT
Leitores escaneiam README rápido. Coloque propósito do projeto e início rápido no topo.
## Padrões de CHANGELOG
```markdown
## 1.2.0 - 2026-05-31
### Adicionado
- Conversor CSV para JSON
### Corrigido
- quebra de toolbar no mobile
Use seções datadas e tipos de mudança agrupados para notas de release escaneáveis.
Templates de issue
Templates devem pedir informação reproduzível:
## Relatório de bug
**Descreva o bug**
**Passos para reproduzir**
1.
2.
**Comportamento esperado**
**Ambiente**
- SO:
- Navegador:
Templates reduzem ida e volta tornando óbvios os detalhes que faltam.
Conclusão
README e issues fortes em Markdown são estruturais, não decorativos. Use títulos para criar caminhos de leitura e mantenha exemplos perto das seções que precisam deles.
Carregue exemplos de README ou issue na ferramenta Visualizar Markdown / Markdown para HTML para checar hierarquia de títulos antes de publicar.