dignifiedquire/borc

Document BORC (API description and benchmarks)

Open

#3 geöffnet am 17. Nov. 2016

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)JavaScript (22 Forks)github user discovery
help wantedready

Repository-Metriken

Stars
 (30 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

  • Add benchmarks
  • Update api description

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene API Dokumentation in der README oder im Quellcode, identifizieren Sie fehlende Beschreibungen und fügen Sie sie hinzu. Für Benchmarks richten Sie einen einfachen Leistungstest mit einem Tool wie `benchmark.js` ein und schreiben Sie Tests, um die CBOR Kodierungs /Dekodierungsgeschwindigkeiten zu messen.
Tech Stack
javascript
Domain
developer experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75