Skip to content

housekeeping for picker-network#16982

Merged
georgewrmarshall merged 4 commits intodevelopfrom
fix-16640
Jan 5, 2023
Merged

housekeeping for picker-network#16982
georgewrmarshall merged 4 commits intodevelopfrom
fix-16640

Conversation

@NidhiKJha
Copy link
Copy Markdown
Member

This PR is to ensure that PickerNetwork adheres to all of the following conventions and standards

  • Has a className prop and the PropType descriptions are all the same
  • Prop table in MDX docs have the "Accepts all Box component props" description and link
  • We are consistent when using the same prop names like size and are suggesting the use of the generalized design-system.js constants e.g. SIZES as the primary option but noting the component consts in the documentation and using them for propType validation and storybook controls only
  • Standardize all similar prop names for images imgSrc, imgAlt(html element + attribute) (needs audit)
  • We have a story for each component prop and we use the prop name verbatim e.g. size prop would be export const Size = (args) => (
  • We have the accompanying documentation for each component prop and we use the prop name verbatim e.g. size prop would be ### Size
  • Are multiple props stories allowed? e.g. Color, Background Color And Border Color story in base-avatar - [ ] yes when it makes sense to
  • All Base components follow the suffix convention e.g. ButtonBase
  • All Base component MDX documentation have the base component notification at the top
  • Add mm- prefix to all classNames
  • className is kebab case version of the component name
  • x ] Spread base components props and reduce duplication of props when props aren't being changed and remain the same for both variant and base components
  • Add component to root index.js file in component-library
  • Add locals for any default text I18nContext as default context
  • Add any "to dos" with a // TODO: comment so we can search for them at a later date e.g. blocking components etc
  • Add snapshot testing
  • Add pixel values to propType descriptions if we use abstracted prop types that relate to pixel values e.g. SIZE.MD (32px)
  • Each prop section in the MDX docs should have: a heading, a description, a story and an example code snipped

@NidhiKJha NidhiKJha added area-UI Relating to the user interface. team-design-system All issues relating to design system in Extension IA/NAV labels Dec 16, 2022
@NidhiKJha NidhiKJha requested a review from a team as a code owner December 16, 2022 13:45
@metamaskbot
Copy link
Copy Markdown
Collaborator

Builds ready [1638a0f]
Page Load Metrics (2217 ± 167 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint1021133190220106
domContentLoaded163134452203347167
load163134452217348167
domInteractive163134452203347167
Bundle size diffs
  • background: 0 bytes
  • ui: 0 bytes
  • common: 0 bytes

highlights:

storybook

Copy link
Copy Markdown
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.

Looking good. Couple nits and left this comment in slack channel avatarNetworkProps https://consensys.slack.com/archives/C02VD8QG0LT/p1671587335207129

@metamaskbot
Copy link
Copy Markdown
Collaborator

Builds ready [0caa7b7]
Page Load Metrics (2327 ± 143 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint1082371512813
domContentLoaded172031322316296142
load172031322327298143
domInteractive172031322316296142
Bundle size diffs
  • background: 0 bytes
  • ui: 0 bytes
  • common: 0 bytes

highlights:

storybook

@georgewrmarshall georgewrmarshall merged commit a1c5224 into develop Jan 5, 2023
@georgewrmarshall georgewrmarshall deleted the fix-16640 branch January 5, 2023 23:30
@github-actions github-actions bot locked and limited conversation to collaborators Jan 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-UI Relating to the user interface. team-design-system All issues relating to design system in Extension

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🧹 [UI House Keeping] PickerNetwork

4 participants