node-formidable / node-formidable/formidable
Documentation: examples could use a readme file
Open
Nobody has claimed this yet.
good first issue
Priority: Low
Status: Available
Type: Documentation
- Dominant language
- JavaScript
- Stars
- 7.2k
- Forks
- 689
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 2
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the examples directory and the three example files mentioned in the issue to understand what each represents and how it is used. Add a README in that directory explaining their intention and usage; done means a newcomer can understand the examples without relying on source comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100