FGRibreau/check-build

Documentation

Open

#8 ouverte le 3 nov. 2014

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

Métriques du dépôt

Stars
 (695 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Direction de recherche
Développez un outil pour vérifier la couverture de la documentation (par exemple, au moins X% des fonctions documentées par fichier) et intégrez le dans l'interface check build.
Stack technique
javascriptnodejs
Domaine
developer experiencetoolingbuild system
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Node.jsnpm
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75