downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open

#1,057 opened on May 20, 2020

View on GitHub
 (2 comments) (3 reactions) (0 assignees)JavaScript (980 forks)batch import
chorehelp wanted

Repository metrics

Stars
 (11,761 stars)
PR merge metrics
 (Avg merge 6d 9h) (5 merged PRs in 30d)

Description

  • downshift version: 5.4.0

Problem description:

Currently, all descriptions of props are found through Github. They are nice and all, but it is a hassle to access the repo every time I need to read further up on the props.

Suggested solution:

Add all descriptions to index.d.ts from the README's in a JSDoc-like format (e.g. typedoc), thus having the descriptions readily available through your IDE/editor of choice

Here is an example of what it may look like in VSCode when a line was added. image

Contributor guide

Research direction
Add JSDoc comments to each prop in index.d.ts by extracting descriptions from the README or source code comments.
Tech stack
typescriptjavascriptreact
Domain
frontend
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
TypeScriptJSDoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90