2 comments (2 comments)0 reactions (0 reactions)0 assignees (0 assignees)JavaScript5,022 stars (5,022 stars)468 forks (468 forks)user submission
help wanted
Description
It would be great if we can test examples in docs/ automatically, is this can be done?
Contributor guide
- Tech stack
- javascriptnodejs
- Domain
- documentationtesting
- Issue type
- feature
- DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
- 3
- Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
- 1-2 days
- Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
- stale
- ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
- needs investigation
- Prerequisites
- Node.jsESLint plugin developmentdocumentation testing
- Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
- 30
- Research direction
- The issue asks about auto testing examples in the docs/ directory. There are no linked PRs or detailed comments. A first step would be to investigate how examples are structured in the docs/ folder and whether there is already a testing framework (e.g., jest). Then propose a concrete plan, perhaps using a script to parse markdown and extract code blocks for testing with the plugin's rules. The issue needs maintainer input to define the scope and acceptance criteria.