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 README for @cypress/react (add commands to run tests) #22477

Merged

Conversation

BeijiYang
Copy link
Contributor

User facing changelog

n/a

Additional details

When I tried to add Cypress component tests into my React app, this README file helped me a lot.

But I got stuck for a while after installing and initialization. I didn't know how to run the component tests. It cost some time to figure it out.

So I added these commands in the README, hope this can save some beginners some time.

How has the user experience changed?

n/a

PR Tasks

  • [n/a] Have tests been added/updated?
  • [n/a] Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
  • [n/a] Has a PR for user-facing changes been opened in cypress-documentation?
  • [n/a] Have API changes been updated in the type definitions?

@BeijiYang BeijiYang requested a review from a team as a code owner June 23, 2022 12:59
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jun 23, 2022

Thanks for taking the time to open a PR!

@CLAassistant
Copy link

CLAassistant commented Jun 23, 2022

CLA assistant check
All committers have signed the CLA.

@BeijiYang BeijiYang force-pushed the update-cypress-react-readme-file branch from fb903f7 to 44b0c31 Compare June 23, 2022 13:08
npm/react/README.md Outdated Show resolved Hide resolved
npm/react/README.md Outdated Show resolved Hide resolved
@lmiller1990
Copy link
Contributor

As of Cypress 10, adding React and Component Testing should be a lot easier. You might want to try setting up a React project with Cypress 10, if you haven't already - it's almost completely automated.

Thanks for the PR either way 👍

Copy link
Contributor

@lmiller1990 lmiller1990 left a comment

Choose a reason for hiding this comment

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

Will look to get this one merged - need to trigger a CI run for this.

@lmiller1990 lmiller1990 self-assigned this Jun 24, 2022
@BeijiYang
Copy link
Contributor Author

Thank you! I'm glad that I can contribute to such a great repo.

@cypress
Copy link

cypress bot commented Jun 28, 2022



Test summary

37681 0 456 0Flakiness 10


Run details

Project cypress
Status Passed
Commit 544c9dc
Started Jun 28, 2022 11:15 PM
Ended Jun 28, 2022 11:35 PM
Duration 19:34 💡
OS Linux Debian - 10.11
Browser Multiple

View run in Cypress Dashboard ➡️


Flakiness

actions/click.cy.js Flakiness
1 ... > scroll-behavior > can scroll to and click elements in html with scroll-behavior: smooth
xhr.cy.js Flakiness
1 ... > logs request + response headers
2 ... > logs Method, Status, URL, and XHR
3 ... > logs response
4 ... > logs response
This comment includes only the first 5 flaky tests. See all 10 flaky tests in the Cypress Dashboard.

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@emilyrohrbough emilyrohrbough merged commit 55aaf76 into cypress-io:master Jun 29, 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.

4 participants