node-formidable/formidable

Documentation: examples could use a readme file

Open

#479 aperta il 26 giu 2018

Vedi su GitHub
 (1 commento) (2 reazioni) (0 assegnatari)JavaScript (701 fork)batch import
Priority: LowStatus: AvailableType: Documentationgood first issue

Metriche repository

Star
 (6741 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Scrivi un README chiaro per la directory examples che spieghi lo scopo di ogni file di esempio e come eseguirli.
Tech stack
javascriptnodejs
Dominio
backenddocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90