Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update usage in README to make it more copy-pasty #326

Merged
merged 4 commits into from
Jan 10, 2021

Conversation

obedparla
Copy link
Contributor

@obedparla obedparla commented Jan 7, 2021

What:

Docs small update.

Why:

I spent some time going through the docs and the issues to enable it all. Could save people some time.

I spent some time going through the docs and the issues to enable it all. Could save people some time.
@codecov
Copy link

codecov bot commented Jan 7, 2021

Codecov Report

Merging #326 (797ebe4) into master (70677a1) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #326   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           23        23           
  Lines          534       534           
  Branches       197       197           
=========================================
  Hits           534       534           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 70677a1...797ebe4. Read the comment docs.

Copy link
Member

@gnapse gnapse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good, but I'm a bit on the fence. We already linked to the jest documentation about the file where jest-dom is to be imported.

Anyway, this is not to object. But I would indeed like to better address the TS vs. JS differences (see comment below). Or hear your thoughts about my thinking.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@obedparla
Copy link
Contributor Author

I was able to set it up with the current readme, but I needed to read into the Jest docs and find how to fix TS in the issues here, and I've used Jest a bit. So I figure some people may benefit from more hand-holding.

@gnapse gnapse changed the title Update usage to make it more copy-pasty docs: Update usage in README to make it more copy-pasty Jan 10, 2021
@gnapse gnapse merged commit c686a78 into testing-library:master Jan 10, 2021
@gnapse
Copy link
Member

gnapse commented Jan 10, 2021

@all-contributors please add @obedparla for docs

@allcontributors
Copy link
Contributor

@gnapse

I've put up a pull request to add @obedparla! 🎉

@github-actions
Copy link

🎉 This PR is included in version 5.11.9 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants