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 (1.965 Stars) (144 Forks)user submission
enhancementhelp wanted

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

Tech Stack
javascripttypescript
Domain
frontenddeveloper experience
Issue Type
feature
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 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
Examine the existing JavaScript codebase for functions and variables that could benefit from JSDoc type annotations. The main source files are likely in the extension's directory. Refer to TypeScript's JSDoc documentation for supported type syntax. No linked PRs or comments indicate specific files.