Skip to content

Commit 5481714

Browse files
committed
Update README.md
1 parent f2c62aa commit 5481714

File tree

1 file changed

+12
-23
lines changed

1 file changed

+12
-23
lines changed

README.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
![es6rocks](https://raw.githubusercontent.com/es6rocks/es6rocks.github.io/master/images/es6rocks.png)
22

33
# How to contribute
4-
Contributing to ES6Rocks is easy, choose what type of contribution you want.
4+
ES6Rocks.com is a collaborative website.
5+
Anyone can contribute by writing an article, making a layout change, suggest new sections, reporting issues, etc.
6+
Contributing to ES6Rocks is super easy, choose the type of contribution you want.
57

68
## Writing an article
79
ES6Rocks website is built with [Harmonic](https://github.com/es6rocks/harmonic/), our static site generator.
810
- First thing you need to do is to install Harmonic.
911
```javascript
1012
npm install harmonic -g
1113
```
12-
You'll need node 0.11.* and npm already installed.
13-
Check out the main [Harmonic documentation](https://github.com/es6rocks/harmonic/) if you're in trouble.
14+
You'll need node 0.11.* and npm already installed.
15+
Check out the main [Harmonic documentation](https://github.com/es6rocks/harmonic/) if you're in trouble.
1416

1517
- Fork and clone the es6rocks.github.io repository
1618
```shell
@@ -26,38 +28,25 @@ git checkout src
2628
```shell
2729
harmonic new_post "My awesome post"
2830
```
29-
This command will create a new markdown file in `/src/posts`.
31+
This command will create a new markdown file in `/src/posts/[LANG]`.
3032

3133
- Test
32-
Run Harmonic to check if your post is ok:
34+
Run Harmonic to check if your post is ready:
3335
```shell
3436
harmonic run
3537
```
3638
This command will build and run the ES6Rocks website in the default port 9356.
3739

38-
- Copy the public folder to the master branch.
39-
The output of `harmonic run` is the `/public` folder.
40-
All you'll need to do is to copy the public folder to the master branch.
41-
```shell
42-
cp public/ -r /tmp/esrocks-website
43-
```
4440
- Commit your changes and checkout to the master branch
4541
```shell
4642
git add .
47-
git commit -m "posts about promises"
48-
git checkout master
43+
git commit -m "postsmy awesome article"
4944
```
50-
- On the master branch, put all the contents from the previously copied public folder
51-
```shell
52-
cp /tmp/esrocks-website/* -r ./
53-
```
54-
- Commit, push and open a pull-request for both master and src branches
55-
```shell
56-
git add .
57-
git commit -m "posts about promises"
58-
git push origin master
5945

60-
git checkout src
46+
- push and open a pull-request for the src branche
47+
```shell
6148
git push origin src
6249
```
6350
Go to your forked repository's page on Github.com and create a pull-request.
51+
52+
## Issues

0 commit comments

Comments
 (0)