Skip to content

Commit 4d6ab5e

Browse files
committed
Preserve original fork workflow and document its remote
1 parent 705a2d0 commit 4d6ab5e

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ This repo contains the source code and documentation powering [react.dev](https:
1010
1. Node: v18.18.0 or greater (see supported versions in [`package.json`](./package.json))
1111
1. Yarn Classic 1.22.22: See [Yarn website for installation instructions](https://classic.yarnpkg.com/en/docs/install/)
1212
1. A fork of the repo (for any contributions)
13-
1. A clone of your fork of the [react.dev repo](https://github.com/reactjs/react.dev) on your local machine
13+
1. A clone of the [react.dev repo](https://github.com/reactjs/react.dev) on your local machine
1414

1515
### Installation
1616

1717
1. `cd react.dev` to go into the project root
18+
2. `git remote add my-fork-name https://github.com/YOUR_USERNAME/react.dev.git` to add your fork as a remote (replace `YOUR_USERNAME` with your GitHub username; only needed once)
1819
3. `yarn` to install the website's npm dependencies
1920

2021
### Running locally
@@ -30,9 +31,8 @@ The documentation is divided into several sections with a different tone and pur
3031

3132
### Create a branch
3233

33-
1. `git remote add upstream https://github.com/reactjs/react.dev.git` to add the source repo as a remote (only needed once)
3434
1. `git checkout main` from any folder in your local `react.dev` repository
35-
1. `git pull --ff-only upstream main` to ensure you have the latest main code
35+
1. `git pull origin main` to ensure you have the latest main code
3636
1. `git checkout -b the-name-of-my-branch` (replacing `the-name-of-my-branch` with a suitable name) to create a branch
3737

3838
### Make the change
@@ -52,7 +52,7 @@ The documentation is divided into several sections with a different tone and pur
5252
### Push it
5353

5454
1. `git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fix header logo on Android`) to stage and commit your changes
55-
1. `git push origin the-name-of-my-branch`
55+
1. `git push my-fork-name the-name-of-my-branch`
5656
1. Go to the [react.dev repo](https://github.com/reactjs/react.dev) and you should see recently pushed branches.
5757
1. Follow GitHub's instructions.
5858
1. If possible, include screenshots of visual changes. A preview build is triggered after your changes are pushed to GitHub.

0 commit comments

Comments
 (0)