TestRenderer and ShallowRenderer docs are extremely limited.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
None of the api methods are thoroughly documented.
None of the api methods have example code provided.
None of the api methods have typing information for arguments and/or return values.
In order to use either of these libraries you have to do a ton of examining debugger results, digging through source code, and/or digging through Stackoverlow.
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 locating the TestRenderer and ShallowRenderer documentation and their public API entry points. Review each API method to identify missing descriptions, examples, and argument or return-value typing information. Done means both libraries have thorough method documentation with examples and typing details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100