gcanti/tcomb-form

Add an examples / recipes section in the doc ?

Aberta

#178 aberto em 14 de ago. de 2015

Ver no GitHubGuia do colaborador
 (1 comentário) (1 reação) (0 responsável)JavaScript (141 forks)batch import
Type: Docshelp wanted

Métricas do repositório

Stars
 (1.164 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Hey,

I was just thinking (yes it happens), looking at the issues raised lately most of them are "how to do X", "how to achieve Y" style of issues, wouldn't be wise to add a section to the doc where we can add examples that answer those questions ? That would help to point others to them.

While I'm at it, you used to have a "playground" section in the doc, any reason this is gone ? Was it too much to maintain or something ?

Again thanks for all the gooood work ^^

Guia do colaborador

Direção de pesquisa
Revise a estrutura da documentação existente e identifique um local adequado para uma seção de exemplos/recipes. Veja como outras bibliotecas organizam exemplos.
Pilha de tecnologia
javascriptreact
Domain
frontend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80