FGRibreau/check-build

Documentation

Open

#8 ouverte le 3 nov. 2014

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)JavaScript (695 stars) (33 forks)batch import
enhancementhelp wanted

Description

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!

Guide contributeur

Stack technique
javascriptnodejs
Domaine
documentationtooling
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Node.jsstatic analysisdocumentation coverage fundamentals
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30
Direction de recherche
Investigate existing documentation coverage tools like jsinspect's approach for code similarity, but adapt to check for function documentation presence per file. Review check build's current plugins and integration point (check build interface). Propose a tool that scans JS files, parses functions, and reports undocumented functions. Then integrate it as a plugin in check build, similar to other checks.