node-formidable/formidable

Documentation: examples could use a readme file

Open

#479 创建于 2018年6月26日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)JavaScript (6,741 star) (701 fork)batch import
Priority: LowStatus: AvailableType: Documentationgood first issue

描述

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.

贡献者指南

技术栈
javascriptnodejs
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.
Documentation: examples could use a readme file · node-formidable/formidable#479 | Good First Issue