winstonjs/winston

Document Http transfer

Offen

#1.118 geöffnet am 30.10.2017

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (1.789 Forks)batch import
DocsHelp Wanted

Repository-Metriken

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

Beschreibung

Hello! There is no documentation about the Http transfer module, other than, that it exists. It would be great to see examples.

Contributor Guide

Research-Richtung
Beginnen Sie mit der Untersuchung des winston Quellcodes, insbesondere des Http Transports in lib/winston/transports/http.js. Verstehen Sie die Konstruktoroptionen (host, port, path usw.) und wie der Transport instanziiert wird. Erstellen Sie dann einen Dokumentationsabschnitt mit Beispielen. Überprüfen Sie vorhandene Testdateien auf Nutzungsmuster. Da das Issue alt ist, stellen Sie sicher, dass die Dokumentation mit der aktuellen Version des Codes übereinstimmt.
Tech Stack
javascript
Domain
backenddocumentation
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80