Document dev setup #14931
Document dev setup #14931
Conversation
Nx Cloud ReportCI ran the following commands for commit 6778fd1. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch
Sent with 💌 from NxCloud. |
docs/contribute/dev-setup.md
Outdated
| yarn bootstrap --core | ||
| ``` | ||
|
|
||
| > **_Note:_** On Windows, you may need to run `yarn` before `yarn bootstrap`! |
There was a problem hiding this comment.
Interesting, it should be the same across all operating systems 🤔
There was a problem hiding this comment.
I haven't verified this, just copied it from CONTRIBUTING.md
docs/contribute/dev-setup.md
Outdated
|
|
||
| Since May 2021 we're strongly encouraging users to create reproductions for their issues. Just like it's possible to [interactively develop](#interactive-development) against example projects in the storybook monorepo, it's also possible to interactively develop against a reproduction repo. | ||
|
|
||
| To do so, run the following command in the root of the Storybook monorepo: |
There was a problem hiding this comment.
| To do so, run the following command in the root of the Storybook monorepo: | |
| To do so, run the following command in the root of the Storybook monorepo as pass the link of the reproduction repo as argument: |
docs/contribute/dev-setup.md
Outdated
|
|
||
| `next` is where all active development happens and corresponds to the latest prerelease of Storybook (e.g. `6.3.0-alpha.25`). | ||
|
|
||
| If you are contributing a bugfix and you want it patched back to the `master` branch, which is where the latest stable version lives (e.g. `6.2.9`), mention that in your PR. We'll try to get it in if the fix looks non-disruptive and corresponds to a critical bug. |
There was a problem hiding this comment.
| If you are contributing a bugfix and you want it patched back to the `master` branch, which is where the latest stable version lives (e.g. `6.2.9`), mention that in your PR. We'll try to get it in if the fix looks non-disruptive and corresponds to a critical bug. | |
| If you are contributing a bugfix and you want it patched back to the `master` branch, which is where the latest stable version lives (e.g. `6.2.9`), mention that in your PR. We'll try to get it in if the fix looks non-disruptive and corresponds to a critical bug. | |
| ## Troubleshooting and feedback | |
| Storybook has a [Discord community](https://discord.gg/storybook) and is open for everyone. There is a dedicated channel for contributors called `#contributing`, so make sure to check it out for feedback or support in the contribution process. The community is the easiest way to reach for maintainers and contributors! | |
There was a problem hiding this comment.
I think it's important to add a section for communication. What do you think?
I made sure the generated link has no invite limit and no expiration.
There was a problem hiding this comment.
Yes, that's great. The official link is https://discord.gg/storybook. Let's use that!
shilman
added
documentation
patch:yes
|
@apapadopoulou you've recently gone through the contribution docs. Care to give some feedback here? Thanks! |
docs/contribute/dev-setup.md
Outdated
| To do so, run the following command in the root of the Storybook monorepo: | ||
|
|
||
| ```sh | ||
| npx sb@next link https://github.com/<some-user>/<some-project>.git |
There was a problem hiding this comment.
@shilman does sb@next link also take a directory as a parameter? I.e, if you want to run the development Storybook against one of your own local Storybooks?
There was a problem hiding this comment.
Great question, currently it expects the input to be a repository url. I think the effort is not really big to add this feature though! It would be quite handy.
|
With the latest commit, I polished and restructured the documentation in an effort to provide a smoother experience for contributors. What was done:
@shilman, @domyen, @winkerVSbecks, @zol, @yannbf if you could take a look at it and leave some feedback on this I would greatly appreciate it and hopefully we get this merged soon. |
shilman
added
the
patch:done
| If you already have a reproduction on your local machine, you can similarly link it to your monorepo dev setup with the `--local` flag: | ||
|
|
||
| ```sh | ||
| npx sb@next link /path/to/local-repro-directory |
There was a problem hiding this comment.
Should this use the --local flag somewhere?
There was a problem hiding this comment.
Oops typo 🤦 thanks! fixing
Issue: N/A
What I did
Started a new section of the official docs for development setup.
This is a rework of
CONTRIBUTING.md, which contains a lot of dense information. The concept of this document is to capture everything you need to get started in an easy walkthrough. We can have sub-sections for more advanced concepts like e2e testing, etc.How to test
N/A