downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Offen

#1.057 geöffnet am 20.05.2020

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)JavaScript (980 Forks)batch import
chorehelp wanted

Repository-Metriken

Stars
 (11.761 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

  • 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-Richtung
Fügen Sie JSDoc Kommentare zu jeder Prop in index.d.ts hinzu, indem Sie Beschreibungen aus der README oder Quellcode Kommentaren extrahieren.
Tech Stack
typescriptjavascriptreact
Domain
frontend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptJSDoc
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90