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 (144 forks)user submission
enhancementhelp wanted

Métriques du dépôt

Stars
 (1 965 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Direction de recherche
Examinez la base de code JavaScript existante pour identifier les fonctions et variables qui pourraient bénéficier d'annotations de type JSDoc. Les fichiers sources principaux se trouvent probablement dans le répertoire de l'extension. Reportez vous à la documentation JSDoc de TypeScript pour la syntaxe de types prise en charge. Aucune PR ou commentaire lié n'indique de fichiers spécifiques.
Stack technique
javascripttypescript
Domaine
frontenddeveloper experience
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScriptTypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90