Skip to content

Commit d83dda4

Browse files
committed
Update docs to point to main branch
1 parent c572e09 commit d83dda4

File tree

26 files changed

+112
-118
lines changed

26 files changed

+112
-118
lines changed

CONTRIBUTING.old.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<h1>Contributing to Storybook</h1>
22

33
- [Issues](#issues)
4-
- [Testing against `master`](#testing-against-master)
4+
- [Testing against `main`](#testing-against-main)
55
- [1. Download the latest version of this project, and build it:](#1-download-the-latest-version-of-this-project-and-build-it)
66
- [2a. Run unit tests](#2a-run-unit-tests)
77
- [Core & Examples Tests](#core--examples-tests)
@@ -53,7 +53,7 @@ No software is bug-free. So, if you got an issue, follow these steps:
5353
- Share error logs, screenshots and etc.
5454
- To speed up the issue fixing process, send us a sample repo with the issue you faced:
5555

56-
### Testing against `master`
56+
### Testing against `main`
5757

5858
To test your project against the current latest version of storybook, you can clone the repository and link it with `yarn`. Try following these steps:
5959

@@ -145,7 +145,7 @@ Then run `yarn cypress open` if you want to see the tests run in the UI, or `yar
145145

146146
#### In the monorepo
147147

148-
The best way to help figure out an issue you are having is to produce a minimal reproduction against the `master` branch.
148+
The best way to help figure out an issue you are having is to produce a minimal reproduction against the `main` branch.
149149

150150
A good way to do that is using the example `cra-kitchen-sink` app embedded in this repository:
151151

@@ -222,9 +222,9 @@ Before you submit a new PR, make sure you run `yarn test`. Do not submit a PR if
222222

223223
### Reviewing PRs
224224

225-
**As a PR submitter**, you should reference the issue if there is one, include a short description of what you contributed and, if it is a code change, instructions for how to manually test out the change. This is informally enforced by our [PR template](https://github.com/storybookjs/storybook/blob/master/.github/PULL_REQUEST_TEMPLATE.md). If your PR is reviewed as only needing trivial changes (e.g. small typos etc), and you have commit access then you can merge the PR after making those changes.
225+
**As a PR submitter**, you should reference the issue if there is one, include a short description of what you contributed and, if it is a code change, instructions for how to manually test out the change. This is informally enforced by our [PR template](https://github.com/storybookjs/storybook/blob/main/.github/PULL_REQUEST_TEMPLATE.md). If your PR is reviewed as only needing trivial changes (e.g. small typos etc), and you have commit access then you can merge the PR after making those changes.
226226

227-
> **_Note:_** Although the latest stable version of storybook corresponds to the `master` branch, nearly all Storybook development happens in the `next` branch. If you submit a PR, branch off `next` and target your PR to `next`.
227+
> **_Note:_** Although the latest stable version of storybook corresponds to the `main` branch, nearly all Storybook development happens in the `next` branch. If you submit a PR, branch off `next` and target your PR to `next`.
228228
229229
**As a PR reviewer**, you should read through the changes and comment on any potential problems. If you see something cool, a kind word never hurts either! Additionally, you should follow the testing instructions and manually test the changes. If the instructions are missing, unclear, or overly complex, feel free to request better instructions from the submitter. Unless the PR is tagged with the `do not merge` label, if you approve the review and there is no other required discussion or changes, you should also go ahead and merge the PR.
230230

@@ -234,7 +234,7 @@ If you are looking for a way to help the project, triaging issues is a great pla
234234

235235
### Responding to issues
236236

237-
Issues that are tagged `question / support` or `needs reproduction` are great places to help. If you can answer a question, it will help the asker as well as anyone who has a similar question. Also in the future if anyone has that same question they can easily find it by searching. If an issue needs reproduction, you may be able to guide the reporter toward one, or even reproduce it yourself using [this technique](https://github.com/storybookjs/storybook/blob/master/CONTRIBUTING.md#reproductions).
237+
Issues that are tagged `question / support` or `needs reproduction` are great places to help. If you can answer a question, it will help the asker as well as anyone who has a similar question. Also in the future if anyone has that same question they can easily find it by searching. If an issue needs reproduction, you may be able to guide the reporter toward one, or even reproduce it yourself using [this technique](https://github.com/storybookjs/storybook/blob/main/CONTRIBUTING.md#reproductions).
238238

239239
### Triaging issues
240240

@@ -385,7 +385,7 @@ This section is for Storybook maintainers who will be creating releases. It assu
385385
The current manual release sequence is as follows:
386386

387387
- Generate a changelog and verify the release by hand
388-
- Push the changelog to master or the release branch
388+
- Push the changelog to main or the release branch
389389
- Clean, build and publish the release
390390
- Cut and paste the changelog to the [GitHub release page](https://github.com/storybookjs/storybook/releases), and mark it as a (pre-) release
391391

@@ -428,8 +428,8 @@ open https://github.com/storybookjs/storybook/releases
428428
#### Full release:
429429

430430
```sh
431-
# make sure you current with origin/master.
432-
git checkout master
431+
# make sure you current with origin/main.
432+
git checkout main
433433
git status
434434

435435
# generate changelog and edit as appropriate

MAINTAINERS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ This document outlines some of the processes that the maintainers should adhere
5858
| nx | Issue, bug, or pull request related to Storybook's integration with [NX](https://nx.dev/) |
5959
| other | Storybook's miscellaneous issue or pull request |
6060
| P(n) | Bug or issue priority. Ranges from `0` (most urgent) to `N` (least urgent) |
61-
| patch | Bug fix and documentation pull request that will be picked to the master branch |
61+
| patch | Bug fix and documentation pull request that will be picked to the main branch |
6262
| performance issue | Issue, bug or pull request that affects Storybook's performance |
63-
| picked | Patch PRs cherry-picked to the master branch |
63+
| picked | Patch PRs cherry-picked to the main branch |
6464
| presets | Issue, bug, or pull requests that affect Storybook's presets |
6565
| question / support | General question about Storybook |
6666
| run e2e extended test suite | Pull request that affects Storybook's testing suite |

0 commit comments

Comments
 (0)