storybook/CONTRIBUTING.md

# Getting started

- Ensure you have node version 14 installed (suggestion: v14.18.1).
- Ensure if you are using Windows to use the Windows Subsystem for Linux (WSL).
- Run `./bootstrap.sh` to install the dependencies, and get the repo ready to be developed on.
- Run `yarn start` inside of the `code` directory to start the development server.

# Generating reproductions

The monorepo has a script that generates Storybook reproductions based on configurations set in the `code/lib/cli/src/repro-templates.ts` file. This makes it possible to quickly bootstrap examples with and without Storybook, for given configurations (e.g. CRA, Angular, Vue, etc.)

To do so:
- Check the `code/lib/cli/src/repro-templates.ts` if you want to see what will be generated
- Run `./generate-repros.sh`
- Check the result in the `repros` directory

# Contributing to Storybook

For further advice on how to contribute, please refer to our [NEW contributing guide on the Storybook website](https://storybook.js.org/docs/react/contribute/how-to-contribute).
add a little bit of documentation in cOntributing.md 2022-07-25 15:13:49 +02:00			`# Getting started`
Add TOC 2021-04-30 10:09:45 +08:00
add a little bit of documentation in cOntributing.md 2022-07-25 15:13:49 +02:00			`- Ensure you have node version 14 installed (suggestion: v14.18.1).`
			`- Ensure if you are using Windows to use the Windows Subsystem for Linux (WSL).`
change to use a shell script instead of having a package.json in the root 2022-07-25 15:46:10 +02:00			- Run `./bootstrap.sh` to install the dependencies, and get the repo ready to be developed on.
add a little bit of documentation in cOntributing.md 2022-07-25 15:13:49 +02:00			- Run `yarn start` inside of the `code` directory to start the development server.

setup yarn version and update docs 2022-07-27 11:16:08 +02:00			`# Generating reproductions`

Examples: Add angular repro template and refactor 2022-08-14 17:11:47 +08:00			The monorepo has a script that generates Storybook reproductions based on configurations set in the `code/lib/cli/src/repro-templates.ts` file. This makes it possible to quickly bootstrap examples with and without Storybook, for given configurations (e.g. CRA, Angular, Vue, etc.)
setup yarn version and update docs 2022-07-27 11:16:08 +02:00
			`To do so:`
Examples: Add angular repro template and refactor 2022-08-14 17:11:47 +08:00			- Check the `code/lib/cli/src/repro-templates.ts` if you want to see what will be generated
setup yarn version and update docs 2022-07-27 11:16:08 +02:00			- Run `./generate-repros.sh`
			- Check the result in the `repros` directory

add a little bit of documentation in cOntributing.md 2022-07-25 15:13:49 +02:00			`# Contributing to Storybook`

			`For further advice on how to contribute, please refer to our [NEW contributing guide on the Storybook website](https://storybook.js.org/docs/react/contribute/how-to-contribute).`