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

Stories rework #3676

Open
22 of 75 tasks
asvae opened this issue Aug 9, 2023 · 0 comments
Open
22 of 75 tasks

Stories rework #3676

asvae opened this issue Aug 9, 2023 · 0 comments
Labels
d4: hard Fast monsters, respawning turrets, templars, reavers, crusaders, and inquisitors epic Feature that is too big to fit in one issue good first issue Right issue if you're new to vuestic storybook Relates to storybook v4: must have This is something really user want to have

Comments

@asvae
Copy link
Member

asvae commented Aug 9, 2023

Right now stories are in bad state. A lot of them either have too much of stuff in them or not enough. Treated somewhat as a temporary code. This hampers storybook usage and leads to regressions.

After rework we should expect development speed to increase and regression rate to decrease.

We'll also be able to publicly share storybook without feeling shame 😞.

We have a decent strategy on how to shape stories for vuestic ui (#3673), but it's not yet in docs. Please keep it close when you're working on stories.

How to progress with this issue:

  • Before you start working on component stories - please add comment or update list to prevent overlap with other devs.
  • Please create separate pr for each component you plan to rework.
  • After your changes are in develop - add pr to the list.
  • We want to prioritize high complexity components (after we understand what we want to do with stories), such as select and table.
  • Please use tailwind for helpers, but not overuse them. Minimum amount of styling is appreciated.
  • For each stories file:
    • Move all stories from vue-book to storybook format
    • Polish every story (minimize amount of code), but don't delve too deep. So if it requires excessive changes in component or significantly tweaking docs, or a lot of investigation - just branch issue from Stories polish #3705 and move your concerns there. With this effort we want to focus on stories, everything else can wait.
    • For Stories polish #3705 - it's welcome to point docs deficiencies or if we're missing stories for some props. Or a need of component rework.
  • v1-v5 - means value, the higher the number - the more valuable story would be for the project

Components

Services

  • color

Styles

  • global
  • grid
  • resources
@asvae asvae added epic Feature that is too big to fit in one issue d4: hard Fast monsters, respawning turrets, templars, reavers, crusaders, and inquisitors v4: must have This is something really user want to have storybook Relates to storybook labels Aug 9, 2023
This was referenced Sep 12, 2023
This was referenced Sep 24, 2023
@asvae asvae added the good first issue Right issue if you're new to vuestic label Oct 12, 2023
Fsss126 added a commit to Fsss126/vuestic-ui that referenced this issue Nov 28, 2023
Fsss126 added a commit to Fsss126/vuestic-ui that referenced this issue Dec 1, 2023
asvae pushed a commit that referenced this issue Dec 8, 2023
* refactor(storybook): Rework VaDropdown stories (#3676)

* refactor(storybook): Review touches for VaAspectRatio.stories.ts (#3676)

* refactor(storybook): Review touches for VaDropdown.stories.ts (#3676)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
d4: hard Fast monsters, respawning turrets, templars, reavers, crusaders, and inquisitors epic Feature that is too big to fit in one issue good first issue Right issue if you're new to vuestic storybook Relates to storybook v4: must have This is something really user want to have
Development

No branches or pull requests

1 participant