testing-library / testing-library/testing-library-docs
Framework wrappers and DOM testing library
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 479
- Forks
- 740
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug Docs seem confusing or conflicting itself
To Reproduce Steps to reproduce the behavior:
Go to this page: https://testing-library.com/docs/user-event/install/
It says:
If you use one of the framework wrappers, it is important that @testing-library/dom is resolved to the same installation required by the framework wrapper of your choice.
Usually this means that if you use one of the framework wrappers, you should not add @testing-library/dom to your project dependencies.
But going to one of the framework wrappers: https://testing-library.com/docs/react-testing-library/intro
It says:
To get started with React Testing Library, you'll need to install it together with its peerDependency @testing-library/dom:
So, should we include @testing-library/dom or not?
Desktop (please complete the following information):
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
Smartphone (please complete the following information):
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
Additional context Add any other context about the problem here.
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
Compare the installation guidance on the user-event install page and the React Testing Library introduction page, including their framework-wrapper links. Determine which @testing-library/dom dependency guidance is consistent, then update the conflicting documentation so both pages give the same clear answer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100