Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Re-enable Storybook #1100

Closed
7 tasks done
kahboom opened this issue Jan 13, 2023 · 3 comments · Fixed by #1805
Closed
7 tasks done

Re-enable Storybook #1100

kahboom opened this issue Jan 13, 2023 · 3 comments · Fixed by #1805
Assignees
Labels
chore Tests, CI/CD, general maintenance

Comments

@kahboom
Copy link
Contributor

kahboom commented Jan 13, 2023

Please describe the task that needs to be done

We should look to re-enable Storybook to continue to ensure that our code base has the separation of concerns for visual components.

  • Re-add Storybook
  • Fix Storybook (again) after class implementation, unless Refactor: Investigate any better way for managing services lifecycle #1233 gets resolved beforehand
  • Add MSW to mock network requests where necessary (see Add mocking for testing #1258, hopefully we can use this mocking for both types of tests)
  • Add stories for components
  • Add documentation for components, where possible
  • Update relevant API keys where necessary
  • Ensure Storybook stories are run on each PR
  • Test the stories, whether through React Testing Library or Cypress component testing TBD, might add too much overhead

Tests should only be run against the main branch and primary repo, not for forks. This could be good to do once #1183 and other refactoring of stateful components is done.

@kahboom kahboom added the chore Tests, CI/CD, general maintenance label Jan 13, 2023
@kahboom kahboom mentioned this issue Feb 3, 2023
5 tasks
@kahboom
Copy link
Contributor Author

kahboom commented Feb 3, 2023

@igarashitm - Originally I wanted to wait to have this once we refactored the UI components into stateless components, but I think it would be good to already start building them again and creating basic stories and docs for the components like this: https://storybook.js.org/addons/@storybook/addon-docs

What do you think? Or wait until the refactor (depending what kind of refactoring you decide to do)? I wouldn't start on this right away but at the end of next week if I finished visual branching and e2e tests in time.

@igarashitm
Copy link
Contributor

definitely +1, storybook is worth paying the cost to maintain, useful for design discussion as well as for detecting visual regression earlier IMO.

@igarashitm
Copy link
Contributor

In theory internal refactoring shouldn't conflict with storybook work - maybe little bit in mock data, but should be manageable.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
chore Tests, CI/CD, general maintenance
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants