josephg/node-foundationdb

Port documentation into typescript doc comments

Offen

#26 geöffnet am 15.03.2019

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (20 Forks)github user discovery
enhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (129 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

There's lots of transaction & database methods which are missing documentation comments.

We should do a pass adding typescript tsdoc - compatible doc comments for all the normal function in (at a minimum) lib/transaction.ts and lib/database.ts.

This documentation is picked up by documentation tools and by editors (like vs code), which makes it very handy while using the API.

Contributor Guide

Research-Richtung
Untersuche die vorhandenen TypeScript Dateien (lib/transaction.ts, lib/database.ts) und füge TSDoc kompatible Dokumentationskommentare zu allen öffentlichen Funktionen und Methoden hinzu, wobei du den Konventionen folgst, die an anderer Stelle in der Codebasis verwendet werden.
Tech Stack
typescript
Domain
apibackend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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
TypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85