node-formidable/formidable

Documentation: examples could use a readme file

Open

#479 ouverte le 26 juin 2018

Voir sur GitHub
 (1 commentaire) (2 réactions) (0 assignés)JavaScript (6 741 stars) (701 forks)batch import
Priority: LowStatus: AvailableType: Documentationgood first issue

Description

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.

Guide contributeur

Stack technique
javascriptnodejs
Domaine
documentation
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 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
This issue requests adding a README to the examples directory. The repository's examples currently lack comments and explanation. The contributor should examine the existing example files (likely in /examples) to understand their structure and purpose, then create a concise README describing each file's intention. The issue body itself provides the motivation, so no further maintainer clarification is needed.