FGRibreau/check-build

Documentation

Open

#8 aberto em 3 de nov. de 2014

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)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!

Guia do colaborador

Pilha de tecnologia
javascriptnodejs
Domain
documentationtooling
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
Node.jsstatic analysisdocumentation coverage fundamentals
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30
Direção de pesquisa
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.