Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add public roadmap #27201

Merged
merged 3 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/contribute/public-roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: 'Public roadmap'
---

The Storybook team maintains a [public roadmap](https://github.com/orgs/storybookjs/projects/20/views/1) in the form of a Github project. This page explainsw what's in the roadmap, how to interpret it, and how to contribute to it.

## What's in the roadmap

Each card represents a Storybook project. The columns represent how larger changes make their way from idea to shipped feature, typically starting as an [RFC](https://github.com/storybookjs/storybook/discussions/categories/rfc) and evolving into a [tracking issue](https://github.com/storybookjs/storybook/issues?q=is%3Aissue++sort%3Aupdated-desc+label%3ATracking+) once the team has fully scoped what the project entails. We ship a Storybook [minor version](https://semver.org/) every two months, and a major once per year, typically in Feb/Mar.

**Candidates.** Ideas on our radar and that we are considering for the current major release. For example, if 8.0 is the most recent major, these would be ideas for 8.x or 9.0. The ideas in this column are the fuzziest and may come and go depending on our priorities.

**Under consideration.** Projects being discussed for the next dev cycle. For example, if the most recent minor is 8.1, and we are currently working on 8.2, the projects in this column would be under consideration for 8.3. Unlike the candidates column, which can contain any idea, the projects under consideration must be documented with an [RFC

**In progress.** Projects that we are currently working on. These come in two flavors:

1. **[Tracking issues](https://github.com/storybookjs/storybook/issues?q=is%3Aissue++sort%3Aupdated-desc+label%3ATracking+)** which are fully scoped and expected to ship in the next minor release. For example, if the most recent minor is 8.1, these should ship in 8.2, eight weeks after 8.1.
2. **Other projects.** Community projects facilitated by the core team and side projects. These don't have an ETA but we will push to have them ready as part of the current major. For example, if 8.0 is the most recent major, these should ship in 8.x or 9.0.

**Done.** These projects are completed, documented, and released. We follow a "fixed time, variable scope" policy for core projects, so we'll cut scope to ship a project on time if we need to (and if the scoped down project can still be useful to users). If a feature has been scoped out of a project, we might try to fit it into a follow-up project, treat it as general maintenance work, or forget about it. Storybook is open source, so PR contributions are always welcome!

## Frequently asked questions

### When will project X be available?

This roadmap is an estimation, not a commitment. In general, every tracking issue "in progress" should be available in the next two months. Everything else on the board has a decent chance of getting into the next major release. For example, if 8.0 is the most recent major release, we will try to ship everything on the board as part of 8.x or 9.0. If we don't think a project is likely for the next major, we will kick it off the board.

### What about issue Y or discussion Z?

The Storybook core team and our community members continuously contribute bug fix bugs and smaller product improvements. The projects here are larger chunks. In some cases they may close out certain issues, and when possible we will call those out in the RFC or project tracking issue.

### How do I get something onto the board?

If there's a significant product improvement that you want to see, and there is currently an issue or an RFC for it, upvote that issue/discussion, and comment on it with more information about your need or use case if it's not currently captured. If you don't see anything that's quite right, please feel free to [submit an RFC](https://github.com/storybookjs/storybook/discussions/new?category=rfc). We prioritize based on a combination of user/contributor interest (upvotes, comments, [Discord](https://discord.gg/storybook) conversations, etc.) and our own strategic ambitions for the project.
5 changes: 5 additions & 0 deletions docs/toc.js
Original file line number Diff line number Diff line change
Expand Up @@ -846,6 +846,11 @@ module.exports = {
title: 'Reproduce',
type: 'link',
},
{
pathSegment: 'public-roadmap',
kylegach marked this conversation as resolved.
Show resolved Hide resolved
title: 'Roadmap',
type: 'link',
},
],
},
{
Expand Down
Loading