sindresorhus/notifier-for-github

[FR] add jsdoc types

Open

#305 geöffnet am 26. Feb. 2025

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (144 Forks)user submission
enhancementhelp wanted

Repository-Metriken

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

Beschreibung

adding typescript types via jsdoc has some benefits:

  • no build changes needed
  • helps with trivial parameter errors and autocompletion
  • helps with new contributors

i'm willing to open a PR.

Contributor Guide

Research-Richtung
Untersuche die bestehende JavaScript Codebasis auf Funktionen und Variablen, die von JSDoc Typanmerkungen profitieren könnten. Die Hauptquelldateien befinden sich wahrscheinlich im Erweiterungsverzeichnis. Siehe die JSDoc Dokumentation von TypeScript für die unterstützte Typsyntax. Verknüpfte PRs oder Kommentare weisen auf keine spezifischen Dateien hin.
Tech Stack
javascripttypescript
Domain
frontenddeveloper experience
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
JavaScriptTypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90