-
-
Notifications
You must be signed in to change notification settings - Fork 9.5k
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
Synced changes from new-docs to CONTRIBUTING.md #1911
Synced changes from new-docs to CONTRIBUTING.md #1911
Conversation
Codecov Report
@@ Coverage Diff @@
## release/3.3 #1911 +/- ##
============================================
Coverage 22.24% 22.24%
============================================
Files 325 325
Lines 6519 6519
Branches 830 830
============================================
Hits 1450 1450
+ Misses 4454 4441 -13
- Partials 615 628 +13
Continue to review full report at Codecov.
|
CONTRIBUTING.md
Outdated
|
||
#### React and Vue | ||
|
||
1. DO NOT RUN `yarn` or `yarn install` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In fact nothing wrong will happen if you do this. With yarn workspaces, you can run yarn
anywhere, and it will bootstrap everything
Now your changes partly duplicate this section (and the 2c subsection above it): https://github.com/storybooks/storybook/blob/eaea3985b31fc290879cd0fbbb811f45b2fb4e52/CONTRIBUTING.md#reproductions |
@Hypnosphi I think that the duplicated steps are relevant in both sections, and if someone is following a guide to setup a dev environment they shouldn't have to go to different parts of the page to get everything working. |
eaea398
to
14a4e8c
Compare
14a4e8c
to
a83cad7
Compare
@ndelangen I don't really have a strong opinion here. What do you think? |
CONTRIBUTING.md
Outdated
|
||
##### 2. Link | ||
|
||
**_Note_**: This process is the same fore `@storybook/vue`, `@storybook/addon-foo`, etc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: fore
=> for
CONTRIBUTING.md
Outdated
|
||
1. Go to your storybook _root_ directory | ||
2. `yarn dev` | ||
3. Wait for the output to stop |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find the wording here vague.. Someone could very easily misunderstand and wait for the program to exit.
It won't.
```sh | ||
yarn link @storybook/react | ||
``` | ||
Within the `examples` folder of the Storybook repo, you will find kitchen sink examples of storybook implementations for the various platforms that storybook supports. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add something along the lines of:
Not only do these show many of the options and addons available, they are also automatically linked to all the development packages. We highly encourage you to use these to develop/test contributions on.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe the answer is to split them apart into multiple pages? The new docs will house a lot of markdown based docs. We can easily link to such documents from CONTRIBUTING.md? |
Should we perhaps have this one large doc as a temporary solution, until the new-docs are ready? In the new docs, these would indeed be on different pages. |
That sounds like a perfectly reasonable way forward 👍 PS. I'm not |
Thanks @dangreenisrael !! 💯 🕶 💪 |
new-docs PR Reference: #1886
orignal PR (to master) #1906
What I did
Synced CONTRIBUTING.md with updated in
new-docs
branchHow to test
N/A: Just added docs