testdouble / testdouble/testdouble.js
Improve flow of getting started doc
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.4k
- Forks
- 140
- Avg merge
- 22h
- Merged PRs (30d)
- 1
Description
Regarding this doc: https://github.com/testdouble/testdouble.js/blob/master/docs/3-getting-started.md#creating-a-test-double
We received these four chat messages as in-the-moment feedback:
this example is abit funky
…as the example, and MathProblem, doesn’t take constructor arg, but the test double example assumes it does
…ah i see, the later example implements the constructor
…kinda lost me until then
Look into these and see if we can pull forward what they need to make the doc read more naturally.
Contributor guide
No contributing guide indexed for this repository
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
Open docs/3-getting-started.md at the Creating a Test Double section and review the examples alongside the four user feedback messages. Rework the explanation or example order so the constructor assumption is clear when first introduced, then confirm the section reads naturally from start to finish.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100