Skip to content

storyblok-components/components

Repository files navigation

Logo

lerna

If you've found an issue or you have feature request - open an issue or look if it was already created.

Contents


How to contribute

  1. Clone repository:
git clone git@github.com:storyblok-components/components.git
  1. Install dependencies by running yarn
  2. Install sb-mig CLI globally
npm install --global sb-mig@latest
  1. Install create-component plugin for sb-mig
sb-mig plugin:install create-component
  1. Run
sb-mig create-component name-of-the-component
  1. It will create folder name-of-the-component inside @storyblok-components folder. Content of the folder:
content
...

  1. When React and Storyblok Schema part are created, and ready to release:
  • a. git checkout -b name-of-branch to create branch
  • a. run git commit -m ""
  • b. it will prompt couple question to be compliant with conventional commits rules
  • c.
git push
  • d. wait for code review

After successfull code review and merge to master, it will be automatically build and deploy to npm. You can install your new component in other projects like:

npm install @storyblok-components/name-of-the-component

or with yarn

yarn add @storyblok-components/name-of-the-component

Roadmap

  • ?

Contibutors

  • Special thanks to Pedro Sousa for lerna magic.