node-formidable/formidable

Documentation: examples could use a readme file

Open

#479 geöffnet am 26. Juni 2018

Auf GitHub ansehen
 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)JavaScript (701 Forks)batch import
Priority: LowStatus: AvailableType: Documentationgood first issue

Repository-Metriken

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

Beschreibung

Hi there, This repo has a good reputation. I'm trying to learn it. The examples could really benefit from a readme file that explains the intention. There are no comments in the examples so it's impossible (for me) to understand what the three files represent or what to do with them.

Contributor Guide

Research-Richtung
Schreiben Sie eine klare README für das examples Verzeichnis, die den Zweck jeder Beispieldatei und deren Ausführung erklärt.
Tech Stack
javascriptnodejs
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
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90