node-formidable/formidable

Documentation: examples could use a readme file

Open

#479 opened on 2018年6月26日

GitHub で見る
 (1 comment) (2 reactions) (0 assignees)JavaScript (6,741 stars) (701 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.