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: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide #27051

Merged
merged 5 commits into from
May 14, 2024

Conversation

hakshu25
Copy link
Contributor

@hakshu25 hakshu25 commented May 7, 2024

What I did

https://storybook.js.org/docs/writing-tests/storyshots-migration-guide#run-image-snapshot-tests-with-the-test-runner

Fixed duplicate 'for' in comments.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@hakshu25 hakshu25 changed the title Fix typo in storyshots-migration-guide Fixed the sample code for image snapshot tests with the test-runner in the Storyshots migration guide May 7, 2024
@hakshu25 hakshu25 marked this pull request as ready for review May 7, 2024 12:55
@hakshu25 hakshu25 changed the title Fixed the sample code for image snapshot tests with the test-runner in the Storyshots migration guide docs: fix the JS sample code for image snapshot tests with the test-runner in the Storyshots migration guide May 7, 2024
@jonniebigodes jonniebigodes self-assigned this May 7, 2024
@hakshu25 hakshu25 changed the title docs: fix the JS sample code for image snapshot tests with the test-runner in the Storyshots migration guide docs: fix the JS sample code for image snapshot tests with the test-runner in the storyshots migration guide May 8, 2024
@hakshu25 hakshu25 changed the title docs: fix the JS sample code for image snapshot tests with the test-runner in the storyshots migration guide docs: fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide May 8, 2024
@hakshu25 hakshu25 changed the title docs: fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide May 8, 2024
@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels May 14, 2024
Copy link

nx-cloud bot commented May 14, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 87a5883. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@hakshu25 appreciate you putting together this pull request and helping us improve the documentation by catching this small typo. We appreciate it 🙏 ! I've checked, and all is good on my end. I will merge this once the checklist clears.

Have a great day.

Stay safe

@jonniebigodes jonniebigodes merged commit 56b17c6 into storybookjs:next May 14, 2024
10 checks passed
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
@github-actions github-actions bot mentioned this pull request May 14, 2024
9 tasks
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
@github-actions github-actions bot mentioned this pull request May 14, 2024
17 tasks
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
@hakshu25 hakshu25 deleted the patch-1 branch May 15, 2024 00:10
storybook-bot pushed a commit that referenced this pull request May 15, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
Docs: Fix typo of sample code for image snapshot tests with the test-runner in the storyshots migration guide
(cherry picked from commit 56b17c6)
@github-actions github-actions bot mentioned this pull request May 15, 2024
9 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants