Skip to content

Latest commit

 

History

History
371 lines (235 loc) · 16.8 KB

CONTRIBUTING.md

File metadata and controls

371 lines (235 loc) · 16.8 KB
Raw

Contributing to Storybook

Thanks for your interest in improving Storybook! We are a community-driven project and welcome contributions of all kinds: from discussion to documentation to bugfixes to feature improvements.

Please review this document to help to streamline the process and save everyone's precious time.

This repo uses yarn workspaces, so you should install [email protected] or higher as package manager. See installation guide.

Issues

No software is bug free. So, if you got an issue, follow these steps:

  • Search the issue list for current and old issues.
    • If you find an existing issue, please UPVOTE the issue by adding a "thumbs-up reaction". We use this to help prioritize issues!
  • If none of that is helping, create an issue with with following information:
    • Clear title (shorter is better).
    • Describe the issue in clear language.
    • Share error logs, screenshots and etc.
    • To speed up the issue fixing process, send us a sample repo with the issue you faced:

Testing against master

To test your project against the current latest version of storybook, you can clone the repository and link it with yarn. Try following these steps:

1. Download the latest version of this project, and build it:

git clone https://github.com/storybooks/storybook.git
cd storybook
yarn install
yarn bootstrap --core

The bootstrap command might ask which sections of the codebase you want to bootstrap. Unless you're going to work with ReactNative or the Documentation, you can keep the default.

You can also pick directly from CLI:

yarn bootstrap --core

2a. Run unit tests

You can use one of the example projects in examples/ to develop on.

This command will list all the suites and options for running tests.

yarn test

The options for running tests can be selected from the cli or be passed to yarn test with specific parameters. Available modes include --watch, --coverage, and --runInBand, which will respectively run tests in watch mode, output code coverage, and run selected test suites serially in the current process.

You can use the --update flag to update snapshots or screenshots as needed.

You can also pick suites from CLI. Suites available are listed below.

Core & React & Vue Tests

yarn test --core

This option executes test from <rootdir>/app/react, <rootdir>/app/vue, and <rootdir>/lib. Before the tests are ran, the project must be bootstrapped with core. You can accomplish this with yarn bootstrap --core

React-Native example Tests

yarn test --reactnative

This option executes tests from <rootdir>/app/react-native. Before these tests are ran, the project must be bootstrapped with the React Native example enabled. You can accomplish this by running yarn bootstrap --reactnative

Integration Tests (Screenshots of running apps)

yarn test --integration

This option executes tests from <rootdir>/integration. In order for the snapshot-integration tests to be executed properly, examples being tested must be running on their defaults ports, as declared in integration/examples.test.js

Puppeteer is used to launch and grab screenshots of example pages, while jest is used to assert matching images.

CRA-kitchen-sink - Image snapshots using Storyshots

yarn test --image

This option executes tests from <rootdir>/examples/cra-kitchen-sink In order for the image snapshots to be correctly generated, you must have static build of the storybook up-to-date.

Puppeteer is used to launch and grab screenshots of example pages, while jest is used to assert matching images. (just like integration tests)

2b. Run e2e tests for CLI

If you made any changes to lib/cli package, the easiest way to verify that it doesn't break anything is to run e2e tests:

yarn test --cli

This will run a bash script located at lib/cli/test/run_tests.sh. It will copy the contents of fixtures into a temporary run directory, run getstorybook in each of the subdirectories, and check that storybook starts successfully using yarn storybook --smoke-test.

After that, the run directory content will be compared with snapshots. You can update the snapshots by passing an --update flag:

yarn test --cli --update

In that case, please check the git diff before commiting to make sure it only contains the intended changes.

2c. Link storybook and any other required dependencies:

If you want to test your own existing project using the github version of storybook, you need to link the packages you use in your project.

    cd app/react
    yarn link

    cd <your-project>
    yarn link @storybook/react

    # repeat with whichever other parts of the monorepo you are using.

Reproductions

The best way to help figure out an issue you are having is to produce a minimal reproduction against the master branch.

A good way to do that is using the example cra-kitchen-sink app embedded in this repository:

    # Download and build this repository:
    git clone https://github.com/storybooks/storybook.git
    cd storybook
    yarn install
    yarn bootstrap --core

    # make changes to try and reproduce the problem, such as adding components + stories
    cd examples/cra-kitchen-sink
    yarn storybook

    # see if you can see the problem, if so, commit it:
    git checkout "branch-describing-issue"
    git add -A
    git commit -m "reproduction for issue #123"

    # fork the storybook repo to your account, then add the resulting remote
    git remote add <your-username> https://github.com/<your-username>/storybook.git
    git push -u <your-username> master

If you follow that process, you can then link to the github repository in the issue. See storybookjs#708 (comment) for an example.

NOTE: If your issue involves a webpack config, create-react-app will prevent you from modifying the app's webpack config, however you can still modify storybook's to mirror your app's version of storybook. Alternatively, use yarn eject in the CRA app to get a modifiable webpack config.

Updating Tests

Before any contributes are submitted in a PR, make sure to add or update meaningful tests. A PR that has failing tests will be regarded as a “Work in Progress” and will not be merged until all tests pass. When creating new unit test files, the tests should adhere to a particular folder structure and naming convention, as defined below.

#Proper naming convention and structure for js tests files
+-- parentFolder
|   +-- [filename].js
|   +-- [filename].test.js

Pull Requests (PRs)

We welcome your contributions. There are many ways you can help us. This is few of those ways:

Before you submit a new PR, make you to run yarn test. Do not submit a PR if tests are failing. If you need any help, create an issue and ask.

Reviewing PRs

As a PR submitter, you should reference the issue if there is one, include a short description of what you contributed and, if it is a code change, instructions for how to manually test out the change. This is informally enforced by our PR template. If your PR is reviewed as only needing trivial changes (e.g. small typos etc), and you have commit access, then you can merge the PR after making those changes.

As a PR reviewer, you should read through the changes and comment on any potential problems. If you see something cool, a kind word never hurts either! Additionally, you should follow the testing instructions and manually test the changes. If the instructions are missing, unclear, or overly complex, feel free to request better instructions from the submitter. Unless the PR is tagged with the do not merge label, if you approve the review and there is no other required discussion or changes, you should also go ahead and merge the PR.

Issue Triage

If you are looking for a way to help the project, triaging issues is a great place to start. Here's how you can help:

Responding to issues

Issues that are tagged question / support or needs reproduction are great places to help. If you can answer a question, it will help the asker as well as anyone searching. If an issue needs reproduction, you may be able to guide the reporter toward one, or even reproduce it yourself using this technique.

Triaging issues

Once you've helped out on a few issues, if you'd like triage access you can help label issues and respond to reporters.

We use the following label scheme to categorize issues:

  • type - bug, feature, question / support, discussion, dependencies, maintenance.
  • area - addon: x, addons-api, stories-api, ui, etc.
  • status - needs reproduction, needs PR, in progress, etc.

All issues should have a type label. bug/feature/question/discussion are self-explanatory. dependencies is for keeping package dependencies up to date. maintenance is a catch-all for any kind of cleanup or refactoring.

They should also have one or more area/status labels. We use these labels to filter issues down so we can easily see all of the issues for a particular area, and keep the total number of open issues under control.

For example, here is the list of open, untyped issues, or here is a list of bugs that have not been modified since 2017-04-01. For more info see searching issues in the Github docs.

If an issue is a bug, and it doesn't have a clear reproduction that you have personally confirmed, label it needs reproduction and ask the author to try and create a reproduction, or have a go yourself.

Closing issues

  • Duplicate issues should be closed with a link to the original.
  • Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline, it is reasonable to wait 2 weeks before closing).
  • bugs should be labelled merged when merged, and be closed when the issue is fixed and released.
  • features, maintenances, greenkeepers should be labelled merged when merged, and closed when released or if the feature is deemed not appropriate.
  • question / supports should be closed when the question has been answered. If the questioner drops offline, a reasonable period to wait is two weeks.
  • discussions should be closed at a maintainer's discretion.

Development Guide

If you want to work on a UI feature, refer to the Storybook UI page.

Prerequisites

Please have the latest stable versions of the following on your machine

  • node
  • yarn

Initial Setup

If you run into trouble here, make sure your node, npm, and yarn are on the latest versions (yarn at least v1.3.2).

  1. cd ~ (optional)
  2. git clone https://github.com/storybooks/storybook.git bonus: use your own fork for this step
  3. cd storybook
  4. yarn
  5. yarn bootstrap --core
  6. yarn test --core
  7. yarn dev You must have this running for your changes to show up

Bootstrapping everything

This method is slow

  1. yarn bootstrap --all
  2. Have a beer 🍺
  3. yarn test (to verify everything worked)

Working with the kitchen sink apps

Within the examples folder of the Storybook repo, you will find kitchen sink examples of storybook implementations for the various platforms that storybook supports.

Not only do these show many of the options and addons available, they are also automatically linked to all the development packages. We highly encourage you to use these to develop/test contributions on.

React and Vue

  1. yarn storybook
  2. Verify that your local version works

Working with your own app

Linking Storybook

Storybook is broken up into sub-projects that you can install as you need them. For this example we will be working with @storybook/react. Note: You need to yarn link from inside the sub project you are working on NOT the storybook root directory

  1. cd app/react
  2. yarn link

Connecting Your App To Storybook

Note: If you aren't seeing addons after linking storybook, you probably have a versioning issue which can be fixed by simply linking each addon you want to use. This applies for the kitchen sink apps as well as your own projects.

Make sure yarn dev is running

1. Setup storybook in your project

First we are going to install storyboook, then we are going to link @storybook/react into our project. This will replace node_modules/@storybook/react with a symlink to our local version of storybook.

  1. getstorybook
  2. yarn storybook
  3. Verify that your local version works
2. Link

Note: This process is the same for @storybook/vue, @storybook/addon-foo, etc

  1. Go to your storybook root directory
  2. yarn dev
  3. Wait until the output stops (changes you make will be transpiled into dist and logged here)
  4. Go to your storybook-sandbox-app directory
  5. yarn link @storybook/react
  6. yarn storybook

Verify your local version is working

You should now have a working storybook dev environment up and running. To verify this you can make changes to the following file:

open app/react/src/client/manager/preview.js

Save and go to http://localhost:9009 (or wherever storybook is running)

If you don't see the changes rerun yarn storybook again in your sandbox app

Release Guide

This section is for Storybook maintainers who will be creating releases. It assumes:

The current manual release sequence is as follows:

  • Generate a changelog and verify the release by hand
  • Push the changelog to master or the release branch
  • Clean, build, and publish the release
  • Cut and paste the changelog to the github release page, and mark it as a (pre-) release

This sequence applies to both releases and pre-releases, but differs slightly between the two.

NOTE: This is a work in progress. Don't try this unless you know what you're doing. We hope to automate this in CI, so this process is designed with that in mind.

Prerelease:

# make sure you current with origin/master.
git checkout release/X.Y
git status

# generate changelog and edit as appropriate
# generates a Next section
yarn changelog Next

# Edit the changelog/PRs as needed, then commit
git commit -m "Updated changelog for vX.Y"

# clean build
yarn bootstrap --reset --core

NOTE: the very first time you publish a scoped package (@storybook/x) you need to publish it by hand because the default for scoped packages is private, and we need to make our packages public. If you try to publish a package for the first time using our lerna publish script, lerna will crash halfway through and you'll be in a world of pain.

# publish and tag the release
npm run publish -- --concurrency 1 --npm-tag=alpha --force-publish=*

# update the release page
open https://github.com/storybooks/storybook/releases

Full release:

# make sure you current with origin/master.
git checkout master
git status

# generate changelog and edit as appropriate
# generates a vNext section
yarn changelog X.Y

# Edit the changelog/PRs as needed, then commit
git commit -m "Changelog for vX.Y"

# clean build
yarn bootstrap --reset --core

# publish and tag the release
npm run publish -- --concurrency 1 --force-publish=*

# update the release page
open https://github.com/storybooks/storybook/releases