derhuerst/svg-radar-chart

Add JSDoc or types to the project for better documentation

Open

#22 opened on May 21, 2024

View on GitHub
 (1 comment) (0 reactions) (1 assignee)JavaScript (13 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (93 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hey mate, thanks for your work

Would it be possible to add JSDoc to the exposed methods of your project so that we can benefit from types? Or export a ts file for typescript users?

Contributor guide

Research direction
Identify all exported functions in the source files and add JSDoc comments with parameter and return type annotations. Optionally, consider creating a TypeScript definition file.
Tech stack
javascript
Domain
frontenddocumentation
Issue type
Documentation
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75