Skip to content

Commit f964e76

Browse files
committed
Simplify contributing docs
Closes #587.
1 parent adeda9f commit f964e76

File tree

1 file changed

+10
-40
lines changed

1 file changed

+10
-40
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ From adding an issue for a documentation suggestion to creating a pull request:
44

55
## Setup
66

7-
* Install [Node.js](https://nodejs.org/) if you have not already.
8-
*Note: Node 6 or greater may be required for "best results".*
7+
* Install [Node.js](https://nodejs.org/) if you have not already.
8+
*Note: Node 4-6 is required for "best results".*. Node 7 may have issues!
99
* Fork the **webpack.js.org** repo at [https://github.com/webpack/webpack.js.org](https://github.com/webpack/webpack.js.org).
1010
* `git clone <your-clone-url> && cd webpack.js.org`
11-
* `git checkout develop`
1211
* `npm install`
1312
* `npm run build`
1413
* `npm start`
@@ -22,55 +21,26 @@ Run `git config user.email` to see your Git email, and verify it with [your GitH
2221

2322
## Editor Config
2423

25-
The [.editorconfig](https://github.com/webpack/webpack.js.org/blob/develop/.editorconfig) in the root should ensure consistent formatting. Please make sure you've [installed the plugin](http://editorconfig.org/#download) if your text editor needs one.
26-
27-
## Git Flow
28-
29-
We are using the [git flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model. Please direct all pull requests to the [develop](https://github.com/webpack/webpack.js.org/tree/develop) branch.
24+
The [.editorconfig](https://github.com/webpack/webpack.js.org/blob/master/.editorconfig) in the root should ensure consistent formatting. Please make sure you've [installed the plugin](http://editorconfig.org/#download) if your text editor needs one.
3025

3126
## Branching Your Changes
3227

33-
Making a branch in your fork for your contribution is helpful in the following ways:
28+
Making a branch in your fork for your contribution is helpful in the following ways:
3429

3530
* It allows you to have multiple contributions in as PRs at once.
3631
* It allows us to identify what your contribution is about from the branch name.
3732

38-
You will want to checkout the `develop` branch locally before creating your new branch.
39-
40-
There are two types of branches:
41-
42-
* Feature
43-
* Hotfix
44-
45-
### Features
46-
47-
If your contribution is something new, like a new section or page or a new chunk to an existing page, you can create a branch with the following naming convention:
48-
49-
`feature/<the-new-feature>`
50-
51-
So, for example, if you are adding a page on how to write a custom loader your branch could have the name:
52-
53-
`feature/add-custom-loaders-page`
54-
55-
### Fixes
56-
57-
If you are fixing existing content or code you can create a branch with the following naming convention:
58-
59-
`hotfix/<the-fix>`
60-
61-
So, for example, if you are fixing spelling on the api configuration page for an option, your branch could have the name:
62-
63-
`hotfix/fix-option-property-spelling-on-api-configuration`
64-
6533
## Submitting Changes
6634

6735
After getting some feedback, push to your fork branch and submit a pull request. We may suggest some changes or improvements or alternatives, but for small changes your pull request should be accepted quickly.
6836

69-
Issue the PR to the [develop](https://github.com/webpack/webpack.js.org/tree/develop) branch.
37+
Issue the PR to the [master](https://github.com/webpack/webpack.js.org/tree/master) branch.
38+
39+
> See [GitHub documentation](https://help.github.com/articles/proposing-changes-to-your-work-with-pull-requests/) for more help.
7040
7141
## Contribution Recognition
7242

73-
Any document that you edit, you can choose to add your Github username at the top of the document for recognition:
43+
Any document that you edit, you can choose to add your GitHub username at the top of the document for recognition:
7444

7545
**example.md**
7646

@@ -80,7 +50,7 @@ title: Some Example Page
8050
contributors:
8151
- TheLarkInn
8252
- Sokra
83-
- Bebraw
53+
- bebraw
8454
- Jhnns
8555
- SpaceK33z
8656
===
@@ -89,7 +59,7 @@ contributors:
8959

9060
```
9161

92-
This will add your name and Github profile photo to the document in production. This is a great way to own the awesome work that you do and encourage that you remember to do this in your PR's.
62+
This will add your name and GitHub profile photo to the document in production. This is a great way to own the awesome work that you do and encourage that you remember to do this in your PR's.
9363

9464

9565
## Thank you

0 commit comments

Comments
 (0)