denodrivers/redis

Add more JSDoc comments

Open

#173 opened on Jan 10, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (49 forks)auto 404
docsgood first issue

Repository metrics

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

Description

We should add more JSDoc comments to RedisCommands (command.ts). It could be useful to the user of the package.

Contributor guide

Research direction
Locate the `command.ts` file in the repository, examine existing JSDoc patterns, and add descriptive JSDoc comments to all public methods and properties in the `RedisCommands` class.
Tech stack
typescript
Domain
backend
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85