Skip to content

Commit 8d741f5

Browse files
committed
docs: upate contributing guide to be more accurate
Spotted two small "imperfections" in CONTRIBUTING.md guide while reading them. - `git remote add` raises and error: remote upstream already exists. That's because GitHub adds them for forked repositories. - `npm install` had an explanation, but `npm run build` did not.
1 parent c6773fd commit 8d741f5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ Next, clone your fork onto your computer (replacing YOUR_USERNAME with your actu
1212
git clone git@github.com:YOUR_USERNAME/web.git
1313
```
1414

15-
Once cloning is complete, change directory to the repository and add the Modern Web project as a remote.
15+
Once cloning is complete, change directory to the repository.
1616

1717
```sh
1818
cd web
19-
git remote add upstream git@github.com:modernweb-dev/web.git
19+
git remote -v # GitHub should add upstream remote for forked repos
2020
```
2121

2222
## Preparing Your Local Environment for Development
@@ -28,7 +28,7 @@ npm install
2828
npm run build
2929
```
3030

31-
This will download and install all packages needed.
31+
This will download and install all packages needed, and prepares for local development.
3232

3333
## Making Your Changes
3434

0 commit comments

Comments
 (0)