winstonjs/winston

Document Http transfer

Ouverte

#1 118 ouverte le 30 oct. 2017

Voir sur GitHubGuide contributeur
 (4 commentaires) (0 réaction) (0 personne assignée)JavaScript (1 789 forks)batch import
DocsHelp Wanted

Métriques du dépôt

Stars
 (21 967 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Commencez par examiner le code source de winston, en particulier le transport Http dans lib/winston/transports/http.js. Comprenez les options du constructeur (host, port, path, etc.) et comment instancier le transport. Ensuite, créez une section de documentation avec des exemples. Examinez les fichiers de test existants pour les modèles d'utilisation. Comme l'issue est ancienne, assurez vous que la documentation correspond à la version actuelle du code.
Stack technique
javascript
Domaine
backenddocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80