sindresorhus/notifier-for-github

[FR] add jsdoc types

Open

#305 opened on Feb 26, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)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.

Contributor guide

Tech stack
javascripttypescript
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.