react18-tools/nextjs-themes

Crete doc comments.

Open

#26 opened on Mar 1, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (6 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (PR metrics pending)

Description

Doc comments are used by modern IDEs to show tooltips. This is very helpful while using the library. It also improves auto-generated documentation.

How to contribute

You can create separate issues for each component or groups of components for which you want to provide the jsdoc comments. Then fork the repo → add appropriate comments and finally create PR targeting the main branch of this repo.

For inspiration, please look at https://github.com/react18-tools/nextjs-themes-ultra.

Contributor guide

Research direction
Identify components lacking JSDoc comments. For each component, add a brief description, parameter types, and return type using JSDoc format. Follow the example in the linked repository for style.
Tech stack
typescriptreact
Domain
frontend
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.
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
GitJavaScript/TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85