dignifiedquire/borc

Document BORC (API description and benchmarks)

Open

#3 opened on Nov 17, 2016

View on GitHub
 (0 comments) (0 reactions) (1 assignee)JavaScript (22 forks)github user discovery
help wantedready

Repository metrics

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

Description

  • Add benchmarks
  • Update api description

Contributor guide

Research direction
Review the existing API documentation in the README or source code, identify missing descriptions, and add them. For benchmarks, set up a simple performance test using a tool like `benchmark.js` and write tests to measure CBOR encoding/decoding speeds.
Tech stack
javascript
Domain
developer experience
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