You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+41-42Lines changed: 41 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@ This repo uses yarn workspaces, so you should install `yarn@1.3.2` or higher as
10
10
11
11
No software is bug-free. So, if you got an issue, follow these steps:
12
12
13
-
-Search the [issue list](https://github.com/storybooks/storybook/issues?utf8=%E2%9C%93&q=) for current and old issues.
14
-
- If you find an existing issue, please UPVOTE the issue by adding a "thumbs-up reaction". We use this to help prioritize issues!
15
-
-If none of that is helping, create an issue with the following information:
16
-
- Clear title (shorter is better).
17
-
- Describe the issue in clear language.
18
-
- Share error logs, screenshots and etc.
19
-
- To speed up the issue fixing process, send us a sample repo with the issue you faced:
13
+
- Search the [issue list](https://github.com/storybooks/storybook/issues?utf8=%E2%9C%93&q=) for current and old issues.
14
+
- If you find an existing issue, please UPVOTE the issue by adding a "thumbs-up reaction". We use this to help prioritize issues!
15
+
- If none of that is helping, create an issue with the following information:
16
+
- Clear title (shorter is better).
17
+
- Describe the issue in clear language.
18
+
- Share error logs, screenshots and etc.
19
+
- To speed up the issue fixing process, send us a sample repo with the issue you faced:
20
20
21
21
### Testing against `master`
22
22
@@ -47,11 +47,11 @@ This command will list all the suites and options for running tests.
47
47
yarn test
48
48
```
49
49
50
-
The options for running tests can be selected from the cli or be passed to `yarn test` with specific parameters. Available modes include `--watch`, `--coverage`, and `--runInBand`, which will respectively run tests in watch mode, output code coverage, and run selected test suites serially in the current process.
50
+
The options for running tests can be selected from the cli or be passed to `yarn test` with specific parameters. Available modes include `--watch`, `--coverage`, and `--runInBand`, which will respectively run tests in watch mode, output code coverage, and run selected test suites serially in the current process.
51
51
52
52
You can use the `--update` flag to update snapshots or screenshots as needed.
53
53
54
-
You can also pick suites from CLI. Suites available are listed below.
54
+
You can also pick suites from CLI. Suites available are listed below.
55
55
56
56
##### Core & Examples Tests
57
57
@@ -147,15 +147,14 @@ When creating new unit test files, the tests should adhere to a particular folde
147
147
| +-- [filename].test.js
148
148
```
149
149
150
-
151
150
## Pull Requests (PRs)
152
151
153
152
We welcome your contributions. There are many ways you can help us. This is few of those ways:
154
153
155
-
-Fix typos and add more [documentation](https://github.com/storybooks/storybook/labels/needs%20docs).
156
-
-Try to fix some [bugs](https://github.com/storybooks/storybook/labels/bug).
157
-
-Work on [API](https://github.com/storybooks/storybook/labels/enhancement%3A%20api), [Addons](https://github.com/storybooks/storybook/labels/enhancement%3A%20addons), [UI](https://github.com/storybooks/storybook/labels/enhancement%3A%20ui) or [Webpack](https://github.com/storybooks/storybook/labels/enhancement%3A%20webpack) use enhancements and new [features](https://github.com/storybooks/storybook/labels/feature%20request).
158
-
-Add more [tests](https://codecov.io/gh/storybooks/storybook/tree/master/packages) (specially for the [UI](https://codecov.io/gh/storybooks/storybook/tree/master/packages/storybook-ui/src)).
154
+
- Fix typos and add more [documentation](https://github.com/storybooks/storybook/labels/needs%20docs).
155
+
- Try to fix some [bugs](https://github.com/storybooks/storybook/labels/bug).
156
+
- Work on [API](https://github.com/storybooks/storybook/labels/enhancement%3A%20api), [Addons](https://github.com/storybooks/storybook/labels/enhancement%3A%20addons), [UI](https://github.com/storybooks/storybook/labels/enhancement%3A%20ui) or [Webpack](https://github.com/storybooks/storybook/labels/enhancement%3A%20webpack) use enhancements and new [features](https://github.com/storybooks/storybook/labels/feature%20request).
157
+
- Add more [tests](https://codecov.io/gh/storybooks/storybook/tree/master/packages) (specially for the [UI](https://codecov.io/gh/storybooks/storybook/tree/master/packages/storybook-ui/src)).
159
158
160
159
Before you submit a new PR, make sure you run `yarn test`. Do not submit a PR if tests are failing. If you need any help, create an issue and ask.
161
160
@@ -179,9 +178,9 @@ Once you've helped out on a few issues, if you'd like triage access you can help
179
178
180
179
We use the following label scheme to categorize issues:
-**area** - `addon: x`, `addons-api`, `stories-api`, `ui`, etc.
183
+
-**status** - `needs reproduction`, `needs PR`, `in progress`, etc.
185
184
186
185
All issues should have a `type` label. `bug`/`feature`/`question`/`discussion` are self-explanatory. `dependencies` is for keeping package dependencies up to date. `maintenance` is a catch-all for any kind of cleanup or refactoring.
187
186
@@ -193,15 +192,15 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p
193
192
194
193
### Closing issues
195
194
196
-
-Duplicate issues should be closed with a link to the original.
197
-
-Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline,
198
-
it is reasonable to wait 2 weeks before closing).
199
-
-`bug`s should be labelled `merged` when merged, and be closed when the issue is fixed and released.
200
-
-`feature`s, `maintenance`s, `greenkeeper`s should be labelled `merged` when merged,
201
-
and closed when released or if the feature is deemed not appropriate.
202
-
-`question / support`s should be closed when the question has been answered.
203
-
If the questioner drops offline, a reasonable period to wait is two weeks.
204
-
-`discussion`s should be closed at a maintainer's discretion.
195
+
- Duplicate issues should be closed with a link to the original.
196
+
- Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline,
197
+
it is reasonable to wait 2 weeks before closing).
198
+
-`bug`s should be labelled `merged` when merged, and be closed when the issue is fixed and released.
199
+
-`feature`s, `maintenance`s, `greenkeeper`s should be labelled `merged` when merged,
200
+
and closed when released or if the feature is deemed not appropriate.
201
+
-`question / support`s should be closed when the question has been answered.
202
+
If the questioner drops offline, a reasonable period to wait is two weeks.
203
+
-`discussion`s should be closed at a maintainer's discretion.
205
204
206
205
## Development Guide
207
206
@@ -211,8 +210,8 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p
211
210
212
211
Please have the **_latest_** stable versions of the following on your machine
213
212
214
-
-node
215
-
-yarn
213
+
- node
214
+
- yarn
216
215
217
216
### Initial Setup
218
217
@@ -295,15 +294,15 @@ If you don't see the changes rerun `yarn storybook` again in your sandbox app
295
294
296
295
This section is for Storybook maintainers who will be creating releases. It assumes:
297
296
298
-
-yarn >= 1.3.2
299
-
-you've yarn linked `pr-log` from <https://github.com/storybooks/pr-log/pull/2>
297
+
- yarn >= 1.3.2
298
+
- you've yarn linked `pr-log` from <https://github.com/storybooks/pr-log/pull/2>
300
299
301
300
The current manual release sequence is as follows:
302
301
303
-
-Generate a changelog and verify the release by hand
304
-
-Push the changelog to master or the release branch
305
-
-Clean, build and publish the release
306
-
-Cut and paste the changelog to the github release page, and mark it as a (pre-) release
302
+
- Generate a changelog and verify the release by hand
303
+
- Push the changelog to master or the release branch
304
+
- Clean, build and publish the release
305
+
- Cut and paste the changelog to the github release page, and mark it as a (pre-) release
307
306
308
307
**NOTE:** The very first time you publish a scoped package (`@storybook/x`) you need to make sure that it's package.json contains the following
309
308
@@ -320,22 +319,22 @@ This sequence applies to both releases and pre-releases, but differs slightly be
320
319
#### Prerelease:
321
320
322
321
```sh
323
-
# make sure you current with origin/master.
324
-
git checkout release/X.Y
322
+
# make sure you current with origin/next.
323
+
git checkout next
325
324
git status
326
325
327
326
# generate changelog and edit as appropriate
328
327
# generates a Next section
329
-
yarn changelog Next
328
+
yarn changelog x.y.z-alpha.a
330
329
331
330
# Edit the changelog/PRs as needed, then commit
332
-
git commit -m "Updated changelog for vX.Y"
331
+
git commit -m "x.y.z-alpha.a changelog"
333
332
334
333
# clean build
335
334
yarn bootstrap --reset --core
336
335
337
336
# publish and tag the release
338
-
npm run publish:alpha
337
+
yarn run publish:next
339
338
340
339
# update the release page
341
340
open https://github.com/storybooks/storybook/releases
@@ -350,16 +349,16 @@ git status
350
349
351
350
# generate changelog and edit as appropriate
352
351
# generates a vNext section
353
-
yarn changelog X.Y
352
+
yarn changelog x.y.z
354
353
355
354
# Edit the changelog/PRs as needed, then commit
356
-
git commit -m "Changelog for vX.Y"
355
+
git commit -m "x.y.z changelog"
357
356
358
357
# clean build
359
358
yarn bootstrap --reset --core
360
359
361
360
# publish and tag the release
362
-
npm run publish
361
+
yarn run publish
363
362
364
363
# update the release page
365
364
open https://github.com/storybooks/storybook/releases
0 commit comments