node-formidable/formidable

Documentation: examples could use a readme file

Open

#479 opened on Jun 26, 2018

View on GitHub
 (1 comment) (2 reactions) (0 assignees)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.

Contributor guide

Tech stack
javascriptnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.