tsdjs/tsd

Improve documentation

Open

#55 aberto em 13 de nov. de 2019

Ver no GitHub
 (12 comments) (0 reactions) (0 assignees)TypeScript (68 forks)user submission
help wantedquestion

Métricas do repositório

Stars
 (2.551 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

I think we need to improve the documentation a bit. But I'm not sure how to provide the right amount of information.

So any ideas here are more than welcome. Like, should we add more examples? Should we add an example per assertion to make it more clear? Is the description good enough?

Guia do colaborador

Direção de pesquisa
Revise a documentação e exemplos existentes, identifique lacunas e proponha melhorias específicas, como adicionar um exemplo por asserção ou esclarecer descrições.
Pilha de tecnologia
typescript
Domain
documentationdeveloper experience
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.
1
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.
Principalmente claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85