FGRibreau/check-build

Documentation

Open

#8 opened on Nov 3, 2014

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (33 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (695 stars)
PR merge metrics
 (No merged PRs in 30d)

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!

Contributor guide

Research direction
Develop a tool to check documentation coverage (e.g., at least X% functions documented per file) and integrate it into the check build interface.
Tech stack
javascriptnodejs
Domain
developer experiencetoolingbuild system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75