docs: remove test results from Storybook #621
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sumup-oss/circuit-ui/40pgv4ttw |
amelako
approved these changes
Jun 18, 2020
docs/remove-tests
docs/remove-tests
connor-baer
force-pushed
the
docs/remove-tests
branch
from
7be2422
to
2dc7fdd
Compare
|
🎉 This PR is included in version 2.0.0-beta.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
5 tasks
5 tasks
|
🎉 This PR is included in version 2.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
We currently display the result of all unit tests in Storybook in a tab at the bottom:
I don't know of anyone who looks at the tab. The tests are always green anyway, since CI wouldn't pass otherwise. So, there doesn't seem to be a use for it.
However, this can lead to confusion for new contributors. Before running
yarn startfor the first time, it's necessary to runyarn test:output -uto generate the test result file that's read by Storybook. Removing this additional step lowers the barrier for first-time contributors.Approach and changes
@storybook/addon-jestaddonjestparameter from story filesDefinition of done