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

Repository metrics

Stars
 (1,965 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Identify functions and modules lacking type annotations, then add JSDoc type comments following existing patterns.
Tech stack
javascripttypescript
Domain
frontenddeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
JavaScriptTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90