@stoplight/storybook-config

Shared storybook config for UI-Kit based project

Usage no npm install needed!

<script type="module">
  import stoplightStorybookConfig from 'https://cdn.skypack.dev/@stoplight/storybook-config';
</script>

README

@stoplight/storybook-config

A shared storybook config for UI-Kit based projects.

Features

  • Awesome: It is.
  • .. more features

Installation

Supported in modern browsers and node.

# latest stable
yarn add --dev @stoplight/storybook-config

Usage

Please refer to UI-Kit repo for an actual usage.

Contributing

  1. Clone repo.
  2. Create / checkout feature/{name}, chore/{name}, or fix/{name} branch.
  3. Install deps: yarn.
  4. Make your changes.
  5. Run tests: yarn test.prod.
  6. Stage relevant files to git.
  7. Commit: yarn commit. NOTE: Commits that don't follow the conventional format will be rejected. yarn commit creates this format for you, or you can put it together manually and then do a regular git commit.
  8. Push: git push.
  9. Open PR targeting the next branch.