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

chore(readme): Update the React 18 upgrade docs #841

Merged
merged 2 commits into from
Aug 15, 2022

Conversation

lukaselmer
Copy link
Contributor

What:

Update the React 18 upgrade docs

Why:

To make it easier to upgrade to React 18

How:

To document what the developer can do to upgrade to React 18

Checklist:

  • Documentation updated
  • Tests
  • Ready to be merged
  • Added myself to contributors table

I tested it manually on my React project

@lukaselmer lukaselmer changed the title Update README.md Update the React 18 upgrade docs May 18, 2022
@netlify
Copy link

netlify bot commented May 18, 2022

Deploy Preview for react-hooks-testing-library failed.

Name Link
🔨 Latest commit 88ecaf0
🔍 Latest deploy log https://app.netlify.com/sites/react-hooks-testing-library/deploys/62f24ebb74462d0008515532

@joshuaellis
Copy link
Member

I personally find that this to be confusing & a little superfluous... I think the current description is fine and we probably don't want to inflate the docs further.

@lukaselmer
Copy link
Contributor Author

lukaselmer commented May 18, 2022

I personally find that this to be confusing & a little superfluous... I think the current description is fine and we probably don't want to inflate the docs further.

I would have helped me. And it seems I'm not the first it would have helped #832 #826 #842. But if you think it doesn't help others then feel free to close it.

@mindplay-dk
Copy link

I spent almost a full day pulling my hair out, as all the tests broke after upgrading - error messages, as always, unhelpful.

This may be totally obvious to people who've been working with testing-library for a while - I just dropped into a project and was asked to upgrade react to 18, and I've never used testing-library, so I don't have that context.

I had to read through numerous long issues, to finally find the explanation at the end of a long issue thread, pointing to this PR.

There's no reason for anyone else to go through that pain - I suggest you get this merged right away.

@lukaselmer
Copy link
Contributor Author

I spent almost a full day pulling my hair out, as all the tests broke after upgrading - error messages, as always, unhelpful.

This may be totally obvious to people who've been working with testing-library for a while - I just dropped into a project and was asked to upgrade react to 18, and I've never used testing-library, so I don't have that context.

I had to read through numerous long issues, to finally find the explanation at the end of a long issue thread, pointing to this PR.

There's no reason for anyone else to go through that pain - I suggest you get this merged right away.

Couldn't agree more :)

@codecov
Copy link

codecov bot commented Aug 15, 2022

Codecov Report

Merging #841 (88ecaf0) into main (7a6e935) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #841   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           15        15           
  Lines          245       245           
  Branches        34        34           
=========================================
  Hits           245       245           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@joshuaellis joshuaellis changed the title Update the React 18 upgrade docs chore(readme): Update the React 18 upgrade docs Aug 15, 2022
@joshuaellis joshuaellis merged commit db18d8c into testing-library:main Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants