FGRibreau/check-build

Documentation

Open

#8 geöffnet am 3. Nov. 2014

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (695 Stars) (33 Forks)batch import
enhancementhelp wanted

Beschreibung

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!

Contributor Guide

Tech Stack
javascriptnodejs
Domain
documentationtooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Node.jsstatic analysisdocumentation coverage fundamentals
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30
Research-Richtung
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.