Skip to content

Commit

Permalink
Merge branch 'next' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
ndelangen authored Nov 28, 2023
2 parents 3b88fbf + 362408f commit 7f67fa8
Show file tree
Hide file tree
Showing 4,344 changed files with 121,211 additions and 135,248 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
366 changes: 178 additions & 188 deletions .circleci/config.yml

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/**/.yarn/** linguist-generated
* -text
40 changes: 40 additions & 0 deletions .github/DISCUSSION_TEMPLATE/help.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
body:
- type: markdown
id: intro
attributes:
value: |
Thanks for taking the time to start a new discussion!
### Before you post
Check if someone has already asked/answered your question in a previous discussion.
### When you're ready to post
Add labels to your discussion (e.g. React, Vue, Vite) to make it clearer for other users.
- type: textarea
id: summary
attributes:
label: Summary
description: How can we help?
validations:
required: true

- type: textarea
id: additional-info
attributes:
label: Additional information
description: |
Share Your Storybook configuration (`main.js` or `main.ts`), your Storybook version number, any error messages, and any relevant dependencies. These help us get a clearer understanding of what might be going wrong.
P.S. Please [share code as text](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) rather than as a screenshot! It makes debugging much easier and faster.
validations:
required: false

- type: input
id: reproduction
attributes:
label: Create a reproduction
description: |
Help us debug by creating a minimal reproduction with [https://storybook.new](https://storybook.new). Learn more about creating a reproduction [here](https://storybook.js.org/docs/react/contribute/how-to-reproduce).
validations:
required: false
37 changes: 37 additions & 0 deletions .github/DISCUSSION_TEMPLATE/ideas.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
labels:
- needs triage
- feature request
body:
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem? Please describe.
description: >-
A clear and concise description of the problem. E.g. I'm always
frustrated when [...]
- type: textarea
id: describe
attributes:
label: Describe the solution you'd like
description: What would you like to see added to Storybook to solve problem?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: Any alternative solutions or features you've considered.
- type: dropdown
id: help
attributes:
label: Are you able to assist to bring the feature to reality?
options:
- 'no'
- yes, I can
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
104 changes: 104 additions & 0 deletions .github/DISCUSSION_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
title: '[RFC] '
labels: ['RFC']
body:
- type: markdown
attributes:
value: |
# Request For Comments
Welcome! 👋
If you are interested in proposing a new feature or improvement to Storybook, then you are in the right place!
This template is designed to help users and contributors propose a solution to a problem, receive feedback, and finally gain alignment.
Thank you for taking the time to improve Storybook.
- type: textarea
id: summary
attributes:
label: Summary
description: |
A brief, 1-5 sentences explanation of the RFC.
validations:
required: true
- type: markdown
attributes:
value: |
## The Problem
- type: textarea
id: problem-statement
attributes:
label: Problem Statement
description: |
A few sentences or bullets summarizing the problem we are trying to solve. Non-core members should be able to read this and understand why we are doing this.
placeholder: |
Doing X is hard because combining Y and Z makes Storybook go 💥...
validations:
required: true
- type: textarea
id: non-goals
attributes:
label: Non-goals
description: |
Key bullets explicitly outlining what is not in-scope.
placeholder: |
Making Y work with W is not part of this proposal because...
- type: markdown
attributes:
value: |
## 🚀 Proposed Solution
Here is where you can get technical!
The goal of this section is to outline the technical changes necessary for the proposed solution.
In most cases, the content of this section will evolve as discussions take place.
- type: textarea
id: implementation
attributes:
label: Implementation
description: |
What are the high level technical (architecture, data structure, UI, etc) changes? Diagrams can be very helpful here.
placeholder: |
I propose a new API for integrating Y with Z to achieve X. The API will be...
validations:
required: true
- type: textarea
id: prior-art
attributes:
label: Prior Art
description: |
Has this been done before, maybe in the broader ecosystem?
placeholder: |
Project A has done something similar for a long time, and the B addon supports this by...
- type: textarea
id: deliverables
attributes:
label: Deliverables
description: |
List out the high-level deliverables that make up this body of work.
Each deliverable should be small enough to be reliably estimable but large enough to represent a meaningful delivery, usually one cycle (2 weeks) worth of work.
placeholder: |
1. Restructure Y to support incoming Z
2. Integrate Z into Y
3. Build V on top of Y and Z
- type: textarea
id: risks
attributes:
label: Risks
description: |
What risks might be introduced by this set of changes? How can we mitigate these risks?
placeholder: |
- This will make it harder to use X in this scenario because...
- type: textarea
id: unresolved-questions
attributes:
label: Unresolved Questions
description: |
Questions we hope to answer as part of this proposal review process.
value: |
- [ ] Using a to do list makes it easy to resolve the questions as we move the RFC along.
- type: textarea
id: alternatives
attributes:
label: Alternatives considered / Abandoned Ideas
description: |
Describe alternative approaches that have been considered and why they have been dropped.
As we discuss this project, it is common for some ideas to be abandoned. Instead of deleting them, let's document the rationale. This way, when people review this proposal in the future, they can avoid the same thinking path and pitfalls we have already learned from.
placeholder: |
I've considered combining U and I, but that is a worse solution because...
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,18 @@ body:
attributes:
label: To Reproduce
description: >-
Please create a reproduction by running `npx sb@next sandbox` and
We prioritize bug reports that have a reproduction. You can create a reproduction using [storybook.new](https://storybook.new), or by running `npx sb@next sandbox` and
following the instructions. Read our
[documentation](https://storybook.js.org/docs/react/contribute/how-to-reproduce)
to learn more about creating reproductions.
placeholder: >-
Paste your repository and deployed reproduction here. We prioritize
issues with reproductions over those without.
Paste a link to your reproduction here. We prioritize issues with reproductions over those without.
- type: textarea
id: system
attributes:
label: System
description: Please paste the results of `npx sb@next info` here.
render: shell
description: Please paste the results of `npx storybook@latest info` here.
render: bash
- type: textarea
id: context
attributes:
Expand Down
21 changes: 15 additions & 6 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
blank_issues_enabled: false
contact_links:
- name: Documentation 📚
- name: View documentation 📚
url: https://storybook.js.org/docs/
about: Check out the official docs for answers to common questions
- name: Questions & discussions 🤔
about: Check out the official docs for answers to common questions.
- name: Feature requests 💡
url: https://github.com/storybookjs/storybook/discussions/new?category=ideas
about: Suggest a feature idea for this project.
- name: Open an RFC 🦄
url: https://github.com/storybookjs/storybook/discussions/new?category=rfc
about: Do you want to propose a more involved change to Storybook? Open an RFC (Request for Comments) to start a discussion.
- name: Questions 💭
url: https://github.com/storybookjs/storybook/discussions/new?category=help
about: Need support with a Storybook problem? Open up a help request.
- name: Discussions 🙌
url: https://github.com/storybookjs/storybook/discussions
about: Ask questions, request features & discuss RFCs
- name: Community Discord 💬
about: Show off your Storybook or discuss the project.
- name: Community Discord 🎉
url: https://discord.gg/storybook
about: Community discussions, interactive support, contributor help
about: Meet other community members and get contributor help.
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/feature_request.yml

This file was deleted.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/update_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Update docs ✍️
description: >-
Find a mistake in our documentation, or have a suggestion to improve them? Let us know here.
title: '[Documentation]: '
labels:
- needs triage
- documentation
body:
- type: textarea
id: description
attributes:
label: Describe the problem
description: A clear and concise description of what is wrong in the documentation or what you would like to improve. Please include URLs to the pages you're referring to.
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context about the problem here.
62 changes: 48 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,32 @@
Closes #

<!-- Thank you for contributing to Storybook! If your PR is related to an issue, provide the number(s) above; if it resolves multiple issues, be sure to break them up (e.g. "closes #1000, closes #1001"). -->
<!-- If your PR is related to an issue, provide the number(s) above; if it resolves multiple issues, be sure to break them up (e.g. "closes #1000, closes #1001"). -->

<!--
Thank you for contributing to Storybook! Please submit all PRs to the `next` branch unless they are specific to the current release. Storybook maintainers cherry-pick bug and documentation fixes into the `main` branch as part of the release process, so you shouldn't need to worry about this. For additional guidance: https://storybook.js.org/docs/contribute
-->

## What I did

<!-- Briefly describe what your PR does -->

## How to test
## Checklist for Contributors

### Testing

<!-- Please check (put an "x" inside the "[ ]") the applicable items below to communicate how to test your changes -->

#### The changes in this PR are covered in the following automated tests:
- [ ] stories
- [ ] unit tests
- [ ] integration tests
- [ ] end-to-end tests

#### Manual testing

_This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!_

<!-- Please include the steps to test your changes here. For example:
Expand All @@ -16,25 +36,39 @@ Closes #
-->

## Checklist
### Documentation

<!-- Please check (put an "x" inside the "[ ]") the applicable items below to make sure your PR is ready to be reviewed. -->
<!-- Please check (put an "x" inside the "[ ]") the applicable items below to indicate which documentation has been updated. -->

- [ ] Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
- [ ] Make sure to add/update documentation regarding your changes
- [ ] Add or update documentation reflecting your changes
- [ ] If you are deprecating/removing a feature, make sure to update
[MIGRATION.MD](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md)

#### Maintainers
## Checklist for Maintainers

- [ ] If this PR should be tested against many or all sandboxes,
make sure to add the `ci:merged` or `ci:daily` GH label to it.
- [ ] Make sure this PR contains **one** of the labels below.
- [ ] When this PR is ready for testing, make sure to add `ci:normal`, `ci:merged` or `ci:daily` GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in `code/lib/cli/src/sandbox-templates.ts`
- [ ] Make sure this PR contains **one** of the labels below:
<details>
<summary>Available labels</summary>

`["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]`
- `bug`: Internal changes that fixes incorrect behavior.
- `maintenance`: User-facing maintenance tasks.
- `dependencies`: Upgrading (sometimes downgrading) dependencies.
- `build`: Internal-facing build tooling & test updates. Will not show up in release changelog.
- `cleanup`: Minor cleanup style change. Will not show up in release changelog.
- `documentation`: Documentation **only** changes. Will not show up in release changelog.
- `feature request`: Introducing a new feature.
- `BREAKING CHANGE`: Changes that break compatibility in some way with current major version.
- `other`: Changes that don't fit in the above categories.

</details>

<!--
### 🦋 Canary release

Everybody: Please submit all PRs to the `next` branch unless they are specific to the current release. Storybook maintainers cherry-pick bug and documentation fixes into the `main` branch as part of the release process, so you shouldn't need to worry about this. For additional guidance: https://storybook.js.org/docs/react/contribute/how-to-contribute
<!-- CANARY_RELEASE_SECTION -->

-->
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the `@storybookjs/core` team here.

_core team members can create a canary release [here](https://github.com/storybookjs/storybook/actions/workflows/canary-release-pr.yml) or locally with `gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>`_

<!-- CANARY_RELEASE_SECTION -->
Loading

0 comments on commit 7f67fa8

Please sign in to comment.