derhuerst/svg-radar-chart

Add JSDoc or types to the project for better documentation

Open

#22 geöffnet am 21. Mai 2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)JavaScript (13 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (93 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Hey mate, thanks for your work

Would it be possible to add JSDoc to the exposed methods of your project so that we can benefit from types? Or export a ts file for typescript users?

Contributor Guide

Research-Richtung
Identifizieren Sie alle exportierten Funktionen in den Quelldateien und fügen Sie JSDoc Kommentare mit Parameter und Rückgabetyp Anmerkungen hinzu. Optional können Sie eine TypeScript Definitionsdatei erstellen.
Tech Stack
javascript
Domain
frontenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75