gcanti/docs-ts

`@types/node` is needed

Open

#32 opened on Mar 8, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (18 forks)github user discovery
accepting PRsgood first issue

Repository metrics

Stars
 (106 stars)
PR merge metrics
 (PR metrics pending)

Description

You need to run yarn add -D @types/node on your project if you want to make use of the assert module in the @example section. Otherwise you get an error when generating the docs.

This should be either mentioned in the readme or included as a (peer)dependency?

Contributor guide

Research direction
Add `@types/node` as a dependency or document the need to install it in the README.
Tech stack
typescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90