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

[BD-46] feat: update script for copying mui-icons and add additional docs #1449

Merged

Conversation

viktorrusakov
Copy link
Contributor

@viktorrusakov viktorrusakov commented Jul 7, 2022

Description

Add additional docs about the copy-mui-icons.js script and update script that generates js / jsx file to handle SVG names that start with numbers

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@openedx-webhooks openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label Jul 7, 2022
@openedx-webhooks
Copy link

Thanks for the pull request, @viktorrusakov!

When this pull request is ready, tag your edX technical lead.

@netlify
Copy link

netlify bot commented Jul 7, 2022

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit bfe7b22
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/62cbf2ff279d3000086e4950
😎 Deploy Preview https://deploy-preview-1449--paragon-openedx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@viktorrusakov viktorrusakov changed the title [BD-46] feat: update script for copying mui-icons and add additional docs [BD-46] feat: update script for copying mui-icons and add additional docs. Jul 7, 2022
@viktorrusakov viktorrusakov changed the title [BD-46] feat: update script for copying mui-icons and add additional docs. [BD-46] feat: update script for copying mui-icons and add additional docs. Jul 7, 2022
@viktorrusakov viktorrusakov changed the title [BD-46] feat: update script for copying mui-icons and add additional docs. [BD-46] feat: update script for copying mui-icons and add additional docs Jul 7, 2022
@viktorrusakov viktorrusakov force-pushed the rusakov/update-icon-script branch 2 times, most recently from 1bd901f to 9c54a2f Compare July 8, 2022 14:07
@codecov
Copy link

codecov bot commented Jul 8, 2022

Codecov Report

Merging #1449 (bfe7b22) into master (75f982c) will increase coverage by 0.18%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1449      +/-   ##
==========================================
+ Coverage   91.12%   91.30%   +0.18%     
==========================================
  Files         205      205              
  Lines        3413     3438      +25     
  Branches      790      799       +9     
==========================================
+ Hits         3110     3139      +29     
+ Misses        289      285       -4     
  Partials       14       14              
Impacted Files Coverage Δ
src/Card/CardImageCap.jsx 92.85% <0.00%> (-7.15%) ⬇️
src/Card/index.jsx 100.00% <0.00%> (ø)
src/Tabs/index.jsx 93.54% <0.00%> (ø)
src/Bubble/index.jsx 100.00% <0.00%> (ø)
src/Card/CardFooter.jsx 100.00% <0.00%> (ø)
src/Card/CardContext.jsx 100.00% <0.00%> (ø)
src/Card/CardSection.jsx 100.00% <0.00%> (ø)
src/Card/CardHeader.jsx 68.18% <0.00%> (+7.07%) ⬆️
src/DataTable/filters/TextFilter.jsx 86.66% <0.00%> (+74.16%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 75f982c...bfe7b22. Read the comment docs.

@viktorrusakov
Copy link
Contributor Author

@adamstankiewicz force-pushes fixed the jobs 😄

@adamstankiewicz
Copy link
Member

@adamstankiewicz force-pushes fixed the jobs 😄

@viktorrusakov Awesome, not sure what caused that hiccup 🤷‍♂️ But at least it's working now haha!

@adamstankiewicz
Copy link
Member

@viktorrusakov An alternative idea to the "humanizing" of numbers here, what if we instead prefixed the component name with Pgn (or some other prefix), so it'd result in:

export { default as Pgn5G } from './5G';

This wouldn't have the issue of dealing with 3+ numbers in the component names. Food for thought. Would love to get your two cents before I merge this as is :)

@adamstankiewicz adamstankiewicz merged commit 0a8ce7f into openedx:master Jul 15, 2022
@openedx-webhooks
Copy link

@viktorrusakov 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-semantic-release pushed a commit that referenced this pull request Jul 15, 2022
# [20.5.0](v20.4.2...v20.5.0) (2022-07-15)

### Bug Fixes

* update script for copying mui-icons and add additional docs ([#1449](#1449)) ([0a8ce7f](0a8ce7f))

### Features

* add autoResize for textarea Form.Control [BD-46] ([#1461](#1461)) ([6bc5320](6bc5320))
* add box shadow variables for all levels and sides ([#1443](#1443)) ([90d0316](90d0316))
@edx-semantic-release
Copy link
Contributor

🎉 This PR is included in version 20.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blended PR is managed through 2U's blended developmnt program released
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add instructions to README in icons directory related to copy-mui-icons.js
4 participants