FGRibreau/check-build

Documentation

Open

#8 aperta il 3 nov 2014

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)JavaScript (33 fork)batch import
enhancementhelp wanted

Metriche repository

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

Descrizione

Develop a tool like "check-docs" or "dox-check" to check that at least X% functions are documented per files. Something like jsinspect but for documentation.

Then add an interface to check-build.

PR are welcome for this!

Guida contributor

Direzione di ricerca
Sviluppa uno strumento per controllare la copertura della documentazione (ad es., almeno X% di funzioni documentate per file) e integralo nell'interfaccia di check build.
Tech stack
javascriptnodejs
Dominio
developer experiencetoolingbuild system
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Node.jsnpm
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75