seangwright/typescript-functional-extensions

Docs: More Consistent JSDoc comments

Offen

#1 geöffnet am 27.12.2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (6 Forks)auto 404
documentationgood first issuehelp wanted

Repository-Metriken

Stars
 (39 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The language describing methods/parameters/return types isn't very consistent across the library.

We need to decide on a few things and then clean it all up:

  • Past/present tense
  • Verbose vs terse method description
    • Details in description or param/return type annotations
  • Comments just for method overload signatures or also for implementation
  • Comments on utility types

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandenen JSDoc Kommentare im Code, identifizieren Sie Inkonsistenzen und schlagen Sie einen Styleguide für JSDoc Kommentare vor.
Tech Stack
typescript
Domain
Keine
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.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
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.
90