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

Update testing snippets for clarity #22276

Open
kylegach opened this issue Apr 26, 2023 · 5 comments
Open

Update testing snippets for clarity #22276

kylegach opened this issue Apr 26, 2023 · 5 comments

Comments

@kylegach
Copy link
Contributor

kylegach commented Apr 26, 2023

Per an internal conversation that surfaced during a QA session for the testing documentation, it was made aware to the learning team that the testing documentation is currently referencing getByTestId in various places and should instead be updated to use getByLabel instead for accuracy, as those references are now outdated or no longer recommended ones in our snippets.

@Karthik-Nayak98
Copy link

I would like to work on this issue.

@kylegach
Copy link
Contributor Author

kylegach commented May 3, 2023

Hi, @Karthik-Nayak98! That would be great! Let us know how we can help.

@Karthik-Nayak98
Copy link

HI @kylegach, I am contributing for the first time. I need some clarification.

As mentioned in the description, I need to replace the getByTestId with getByLabel in the markdown file right? Or anything else I need to do?

Can you please guide me?

@jonniebigodes
Copy link
Contributor

Hey @Karthik-Nayak98 , and first and foremost, thanks for your willingness to contribute to Storybook by updating the documentation. Greatly appreciate it 🙏 ! To give you a bit of an overview of what this entails, you'll need to check and update the snippets where getByTestId is used and update it to getByLabel instead. To help you with this, we have documentation on how to work with the code snippets in our documentation here. Also, if you're ok with it, could you provide us with a reproduction to help us validate it once you've pushed the pull request? To help you get onboarded quicker, we have a set of sandboxes here that can aid you with it.

Looking forward to seeing your pull request.

Hope you have a great weekend.

Stay safe

@kylegach
Copy link
Contributor Author

kylegach commented Jun 5, 2023

Hey @Karthik-Nayak98, are you still interested in helping with this?

Otherwise, we'll tackle it as part of #22598

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Community Effort
Development

No branches or pull requests

3 participants