entropic-dev/ds

Write documentation for all existing error codes

Open

#51 opened on Dec 21, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (6 forks)github user discovery
documentationgood first issuehelp wanted

Repository metrics

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

Description

The DsErrContext codes in packages/ds-error-context are mostly missing docstrings. It would be great to do a pass through all the current codes and make sure they have helpful docstrings attached to them!

Contributor guide

Research direction
Review each error code in packages/ds error context and add docstrings explaining when the error occurs.
Tech stack
rust
Domain
documentation
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.
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.
90