libp2p/js-libp2p-crypto

Documentation

Open

#71 opened on Feb 10, 2017

View on GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (49 forks)auto 404
P1exp/experthelp wantedstatus/ready

Repository metrics

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

Description

We don't have all the funcs available through this lib documented.

We also don't have documented the optional dependency, which causes confusion as seen https://github.com/libp2p/js-libp2p-crypto/issues/70

Contributor guide

Research direction
Review the existing functions and their source code to write descriptions. Also document the optional dependency mentioned in the linked issue.
Tech stack
typescript
Domain
cryptography
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
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80