learn(fs): refresh
Open
Nobody has claimed this yet.
help wanted
- Dominant language
- JavaScript
- Stars
- 29
- Forks
- 165
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 2
Description
IMO, the part about the FS is not quite right and there are missing parts.
- The title of subsection "Manipulating Files" should be something like "working with file system" because the content is just not about file it's also about folder.
- Adding a intorudction of
fs/fs/promises+ what mean file system ... like introduction of test runner - Include glob paterns
- more examples with cjs/esm
Remaining question:
- Should we put ESM example as first ?
- Should we put
fs/promisesas first. - How to handle difference between
fsandfs/promises
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 with the “Manipulating Files” subsection and review its existing coverage of fs and fs/promises. Clarify the section title, explain the file system and glob patterns, and add CJS/ESM examples; done means the ordering and treatment of fs versus fs/promises are resolved in the updated guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100