Link Search Menu Expand Document

Pull Requests: Storybook Links

It is very helpful to add a link to the storybook any time you are:

  • Adding new storybook story source code files
  • Modifying existing React components

The repos we work with in CS156 typically have a github action that publishes a storybook to the repo’s Github Pages site every time you make a PR to the main branch.

You can find this page by navigating to the repos main page, e.g.

image

When you click there, you’ll see a page like this one. Find the storybook link that corresponds to your PR

image

Click to go to that storybook. Then, look in the navigation at left and find the specific stories that are relevant to the files added or changed in your PR. For example, if adding a new component CoursesTable, you want to find the story for that new component, and bring it up:

image

Such as this:

image

Grab that URL, and put it into the PR description, like this:

image

This allows folks that are reviewing the PR to immediately go to a deployed example of what the component looks like.