Code-the-Dream-School / Code-the-Dream-School/node-essentials
Assignment 1 miscellaneous (significant!) problems
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 11
- Avg merge
- 4d 13h
- Merged PRs (30d)
- 2
Description
-
The assignment asks the student to use callbacks, then a Promise, then async/await. What is meant by the second part, I think is a Promise that is resolved a .then(). It isn't clear. Also, the sample solution for "callback hell" is perhaps not the best, because the operations don't have to be serialized. File open/read/close of one file would be a better example.
-
The assignment asks the student to use a read stream. Streams are not explained in the lesson however. We could point the student to the documentation and make it clear that this part is a bonus.
-
The sample answer has a questionable practice, that being writing to the stream without checking the return code. If the return code is false, it is necessary to wait for the stream to drain. Of course it doesn't fail in this case, but we want to teach the best practice.
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 Assignment 1, its lesson, and the sample answer referenced in the issue. Review the callback, Promise, async/await, read-stream, and stream-writing guidance, then verify that the assignment wording and examples clearly describe the expected practices, including the stream bonus and backpressure behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100