PR Template Requests Running Tests But Gives No Instruction
See original GitHub issueUpdate: Resolved. There is a link—outside the PR description—to the contribution guide. Also, #17713.
Is your feature request related to a problem? Please describe Yes. My PR is #17702, but anyone opening a PR for a UI change may be requested to run Jest or Chromatic tests.
There is no instruction for testing, and the process was too much for so small a change, yet the request was still made.
Describe the solution you’d like A link in the Pull Request template to instructions for how to perform tests requested.
I support requesting testing, but I do not support the unexpected trouble when trying to test. See “Additional context”.
Describe alternatives you’ve considered
- Researching on my own how to run the requested tests. See “Additional context”.
- Improving the wording of the PR template to disregard testing for a minuscule changes.
Are you able to assist to bring the feature to reality? Yes, but I am too angry at the moment to promise to assist beyond creating this ticket.
Additional context
I took many steps to run the test suite, but eventually failed. Click for details.
-
Clone my fork of the repo.
-
Run
yarn install
. -
Run
yarn jest
. -
See tests fail because dev dependencies were not installed.
-
Fail to install all dependencies because I was using a command for Yarn Classic.
-
Determine my yarn version… version 3.
-
Fail to learn how to install all dev dependencies with Yarn 3.
-
Learn how to downgrade to Yarn Classic.
-
Install all dev dependencies.
-
Be asked for which version to use for every
@storybook/...
dev dependency! [^1]Couldn't find any versions for "@storybook/svelte" that matches "workspace:*" ? Please choose a version of "@storybook/svelte" from this list:
I chose
6.5.0-alpha.47
for every options, because I am impatient and annoyed. -
Be lambasted with many warnings.
-
Receive one error:
error An unexpected error occurred: "expected workspace package to exist for \"react-router-dom\"".
-
Run
yarn jest
. -
Receive more reports of missing dependencies. See snippet.
-
Give up!
[^1]: Why is a known working version of each dependency not pinned?!
Issue Analytics
- State:
- Created 2 years ago
- Comments:5 (5 by maintainers)
Jeepers creepers!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.5.0-alpha.52 containing PR #17713 that references this issue. Upgrade today to the
@next
NPM tag to try it out!No worries @tacc-wbomar! I totally understand your frustration and I hope others don’t go through similar experience.
I see value in improving the PR template and I’m looking forward to seeing yet another contribution from you!