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: add importance of subpath import order #28546

Conversation

andrejilderda
Copy link
Contributor

Closes #28282

What I did

Add the important of the subpath import order as stated by shilman here.

Checklist for Contributors

Testing

N/A — Docs-only change

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>

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

  • Added note on the importance of subpath import order in docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx
  • Specified that the 'default' key should come last in subpath imports configuration to avoid resolution issues

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

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.

@andrejilderda, thank you again for putting together this follow-up pull request and helping us improve the documentation. We're extremely grateful 🙏 !

I've checked and all is good on my and will gladly merge this once the checklist clears.

Hope you have an amazing day.

Stay safe

@jonniebigodes jonniebigodes changed the title docs: add importance of subpath import order Docs: add importance of subpath import order Jul 11, 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 Jul 11, 2024
Copy link

nx-cloud bot commented Jul 11, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 0740b24. 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.

@jonniebigodes jonniebigodes merged commit f8f9f1b into storybookjs:next Jul 11, 2024
7 of 8 checks passed
storybook-bot pushed a commit that referenced this pull request Jul 11, 2024
…ubpath-import-order

Docs: add importance of subpath import order
(cherry picked from commit f8f9f1b)
@github-actions github-actions bot mentioned this pull request Jul 11, 2024
7 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 11, 2024
@github-actions github-actions bot mentioned this pull request Jul 12, 2024
33 tasks
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.

[Bug]: Unable to Mock Modules in Storybook
2 participants