testing-library / testing-library/testing-library-docs
Improving and Diversifying the Testing Library Recipes
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 479
- Forks
- 740
- PR merge metrics
- No merged PRs in 30d
Description
Hi all! I was thinking of adding/migrating some examples of Vue Testing Library (VTL) to the Testing Library docs so people could easily find ways to handle some common use cases. I thought the best place for that would be the recipes. But there's no folder-like structure, and most of the examples seem to be React-related.
So I'm looking for some guidance. Are there any thoughts on how the recipes should be structured to accommodate the entire testing library ecosystem? Or should everything be put under an "Examples" tab under each framework on the docs page? (Or should examples be put on GitHub? It seems some libraries do that.) There seems to be some inconsistency between frameworks. So I just wanted to verify "the ideal" before doing anything.
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 recipes page at https://testing-library.com/docs/recipes and compare it with the framework documentation linked from https://testing-library.com/docs/. Identify the existing recipe organization and framework inconsistencies, then seek maintainer agreement on a structure; done means there is a decided approach for adding or migrating Vue Testing Library examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100