Skip to content

Commit e0773f6

Browse files
committed
Merge pull request JSRocksHQ#22 from es6rocks/contributing
Update contributing guide
2 parents 4ec9ca7 + 39f6bf5 commit e0773f6

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,16 @@ Check out the main [Harmonic documentation](https://github.com/es6rocks/harmonic
1616

1717
- Fork and clone the es6rocks.github.io repository
1818
```shell
19-
git clone [email protected]:[USER]/es6rocks.github.io.git
19+
# replace YOUR_USERNAME with your GitHub username below
20+
git clone https://github.com/YOUR_USERNAME/es6rocks.github.io.git
21+
cd es6rocks.github.io
22+
git remote add upstream https://github.com/es6rocks/es6rocks.github.io.git
2023
```
2124

22-
- Checkout to the `src` branch
25+
- Create a new branch using `upstream/src` as base and checkout to it
2326
```shell
24-
git checkout src
27+
git fetch upstream
28+
git checkout -b my-awesome-post upstream/src
2529
```
2630

2731
- Create a new post
@@ -42,11 +46,11 @@ git add .
4246
git commit -m "my awesome article"
4347
```
4448

45-
- push and open a pull-request for the `src` branch
49+
- Push your new branch to your forked repository
4650
```shell
47-
git push origin src
51+
git push origin HEAD
4852
```
49-
Go to your forked repository's page on Github.com and create a pull-request.
53+
Go to your forked repository's page on Github.com and create a pull request for the `src` branch.
5054

5155
## Issues
5256
You can help ES6Rocks by finding a bug in the website, a typo in an article or even an incorrect sentence.

0 commit comments

Comments
 (0)