Back to Storybook

PR Process

MAINTAINERS.md

10.3.612.6 KB
Original Source

This document outlines some of the processes that the maintainers should adhere to.

PR Process

  1. Triage with the correct label
  2. If there is a change related to it, ensure it has been published and tested before closing

Labels

label namepurpose
accessibilityIssue, bug, or pull request related to accessibility
addon:(name)Issue, bug, or pull request related to Storybook addons (e.g., Controls)
app:(name)Issue, bug, or pull request related to Storybook's supported frameworks (e.g., React)
api:(name)Issue, bug, or pull request related to Storybook's API (e.g.,makeDecorator)
argsIssue, bug, or pull request related to Storybook's args
babel/webpackIssue, bug, or pull request related to Storybook's build system (e.g., Webpack or Babel), for Webpack 5 issues see below
block:(name)Issue or bug within a certain surface are of Storybook (e.g., argTypes)
BREAKING CHANGEIssue or pull request that introduces a breaking change within Storybook's ecosystem.
BREAKING PRERELASEBreaking, but only for prerelease users (not relative to the stable release)
build-storybookIssue, bug, or pull request related to Storybook's production build
cleanupMinor cleanup style change that won't show up in release changelog
bugA bug within Storybook
cliIssue, bug, or pull request that affects the Storybook's CLI
compatibility with other toolsIssue, bug, or pull request between Storybook and other tools (e.g., Nuxt)
componentsIssue, bug, or pull request related to Storybook's internal components
compositionIssue, bug, or pull request related to Storybook Composition
configurationIssue, bug, or pull request related to Storybook configuration
coreIssue, bug, or pull request related to Storybook's Core
craIssue, bug, or pull request that affects Storybook's compatibility with Create React APP (CRA)
CSFIssue, bug, or pull request related to Storybook's Component Story Format (CSF)
decoratorsIssue, bug, or pull related to Storybook's Decorators
dependenciesIssue, bug, or pull request that related to upstream dependencies
discussionIssue currently being discussed between the maintainers and community
do not mergePull request that will introduce regressions and will not be merged
documentationIssue, bug, or pull request that affects Storybook's documentation
duplicateQuestion or issue already asked in the repo's issues
feature requestRequest for a new feature to be included in Storybook
flowIssue, bug, or pull request related to Storybook and Flow
Funded on IssuehuntStorybook issue funded on IssueHunt
gatsbyIssue, bug, or pull request that affects Storybook and Gatsby
good first issueLow impact Storybook issues that help new members get involved and start contributing
has workaroundIssue or bug that has an alternative way to be solved with Storybook
help wantedIssue, or bug that requires additional help from the community
ie11Issue, bug, or pull request related to Storybook and IE11
in progressIssue or pull request that is currently being reviewed or worked on with the author
inactiveIssue, or pull request that has gone stale and no active development has been done
maintenanceIssue, or pull request related to Storybook's internal maintenance
mdxIssue, bug, or pull request related to MDX and Storybook
mediumIssue or pull request that involves a significant amount of work within Storybook
monoreposIssue, bug, or pull request related to Storybook and monorepos
muiIssue, bug, or pull request that affects Storybook and Material-UI
multiframeworkIssue, bug, or pull request that affects multiple supported frameworks (e.g., React, Vue)
needs more infoIssue, or bug that requires additional context from the author
needs reproductionIssue, or bug that requires a reproduction to be looked at
needs triageIssue, bug, or pull request that requires further investigation from the maintainers
nextjsIssue, bug, or pull request related to Storybook's integration with Next.js
nxIssue, bug, or pull request related to Storybook's integration with NX
otherStorybook's miscellaneous issue or pull request
P(n)Bug or issue priority. Ranges from 0 (most urgent) to N (least urgent)
patchBug fix and documentation pull request that will be picked to the main branch
performance issueIssue, bug or pull request that affects Storybook's performance
pickedPatch PRs cherry-picked to the main branch
presetsIssue, bug, or pull requests that affect Storybook's presets
question / supportGeneral question about Storybook
run e2e extended test suitePull request that affects Storybook's testing suite
searchIssue, bug or pull request related to Storybook's search functionality
securityIssue, bug, or pull request that addresses security with Storybook
smallIssue or pull request that requires a small amount of work to be done
source-loaderIssue, bug, or pull request related to code display within Storybook's stories
themingIssue, bug, or pull request related to Storybook customization (e.g., theming)
todoIssue or pull request currently being worked on
typescriptIssue, bug, or pull request related to TypeScript
uiIssue, bug, or pull request related to Storybook's UI
webpack5Issue, bug, or pull request related to Webpack 5
won't fixIssue or pull request that won't be addressed by the maintainers (e.g., introduces a regression)
yarn/npmIssue or pull request related to node package managers