sindresorhus/notifier-for-github

[FR] add jsdoc types

Open

#305 ouverte le 26 févr. 2025

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)JavaScript (1 965 stars) (144 forks)user submission
enhancementhelp wanted

Description

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.

Guide contributeur

Stack technique
javascripttypescript
Domaine
frontenddeveloper experience
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
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.