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

Component-Library storybook introduction fix #19359

Merged
merged 4 commits into from
Jun 5, 2023

Conversation

dhruvv173
Copy link
Contributor

Explanation

Screenshots/Screencaps

Before

image

After

image

Manual Testing Steps

Pull this branch
run yarn storybook
check Introduction in ComponentLibrary

Pre-merge author checklist

  • I've clearly explained:
    • What problem this PR is solving
    • How this problem was solved
    • How reviewers can test my changes
  • Sufficient automated test coverage has been added

Pre-merge reviewer checklist

  • Manual testing (e.g. pull and build branch, run in browser, test code being changed)
  • PR is linked to the appropriate GitHub issue
  • IF this PR fixes a bug in the release milestone, add this PR to the release milestone

If further QA is required (e.g. new feature, complex testing steps, large refactor), add the Extension QA Board label.

In this case, a QA Engineer approval will be be required.

@dhruvv173 dhruvv173 requested a review from a team as a code owner May 31, 2023 19:18
@dhruvv173 dhruvv173 requested a review from micaelae May 31, 2023 19:18
@github-actions
Copy link
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@dhruvv173
Copy link
Contributor Author

hey @georgewrmarshall, could you please review this PR?
Thanks!

@codecov
Copy link

codecov bot commented May 31, 2023

Codecov Report

Merging #19359 (a0de350) into develop (16e07b5) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop   #19359      +/-   ##
===========================================
- Coverage    69.94%   69.93%   -0.01%     
===========================================
  Files          959      959              
  Lines        36822    36822              
  Branches      9455     9455              
===========================================
- Hits         25753    25751       -2     
- Misses       11069    11071       +2     

see 2 files with indirect coverage changes

@georgewrmarshall georgewrmarshall added the team-design-system All issues relating to design system in Extension label May 31, 2023
Copy link
Contributor

@georgewrmarshall georgewrmarshall left a comment

Choose a reason for hiding this comment

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

Hey @dhruvv173, this looks great. Can you please update the name COMPONENT-LIBRARY.stories.mdx to README.stories.mdx we still want a readme and I'm hoping it will still show up on GitHub ok so there is still readable documentation about the component-library without having to run storybook

@dhruvv173
Copy link
Contributor Author

Hey @dhruvv173, this looks great. Can you please update the name COMPONENT-LIBRARY.stories.mdx to README.stories.mdx we still want a readme and I'm hoping it will still show up on GitHub ok so there is still readable documentation about the component-library without having to run storybook

I renamed the file but it does not show up on GitHub as a README, should I make a README.md and paste the content there aswell?

@dhruvv173
Copy link
Contributor Author

hey @georgewrmarshall, I did some research and found the fix to this. Now, it can be read on GitHub with README.md and on Storybook with COMPONENT-LIBRARY.stories.mdx. Attaching screenshots below from latest commit for reference.
I renamed the stories file as well, could you please check this once?

image
image

Copy link
Contributor

@georgewrmarshall georgewrmarshall left a comment

Choose a reason for hiding this comment

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

Hey @dhruvv173, checked out the branch looks good made a couple small updated wile I was there. Thanks for your contribution!

@@ -36,4 +36,4 @@ We are currently in the process of migrating all component-library components to

If internal folks have any questions please reach out the design system team via the internal slack channel [#metamask-design-system](https://consensys.slack.com/archives/C0354T27M5M) 💁

[DS components figma file](https://www.figma.com/file/HKpPKij9V3TpsyMV1TpV7C/DS-Components?node-id=16%3A6) (internal)
[DS components figma file](https://www.figma.com/file/HKpPKij9V3TpsyMV1TpV7C/DS-Components?node-id=16%3A6) (internal)
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh we made our Figma UI Kit publicly viewable so we can remove "(internal)"

Suggested change
[DS components figma file](https://www.figma.com/file/HKpPKij9V3TpsyMV1TpV7C/DS-Components?node-id=16%3A6) (internal)
[DS components figma file](https://www.figma.com/file/HKpPKij9V3TpsyMV1TpV7C/DS-Components?node-id=16%3A6)

Copy link
Contributor

@georgewrmarshall georgewrmarshall left a comment

Choose a reason for hiding this comment

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

Ah missed the rename of the file. Nice work

@NidhiKJha NidhiKJha merged commit 5c5de03 into MetaMask:develop Jun 5, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jun 5, 2023
@dhruvv173 dhruvv173 deleted the component-library-storybook branch July 18, 2023 07:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
external-contributor team-design-system All issues relating to design system in Extension
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix component-library storybook introduction MDX render
4 participants