tsdjs/tsd

Improve documentation

Open

#55 aperta il 13 nov 2019

Vedi su GitHub
 (12 commenti) (0 reazioni) (0 assegnatari)TypeScript (68 fork)user submission
help wantedquestion

Metriche repository

Star
 (2551 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Rivedi la documentazione e gli esempi esistenti, identifica le lacune e proponi miglioramenti specifici come l'aggiunta di un esempio per ogni asserzione o la chiarificazione delle descrizioni.
Tech stack
typescript
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85