You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-40Lines changed: 10 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,10 @@ From adding an issue for a documentation suggestion to creating a pull request:
4
4
5
5
## Setup
6
6
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!
9
9
* Fork the **webpack.js.org** repo at [https://github.com/webpack/webpack.js.org](https://github.com/webpack/webpack.js.org).
10
10
*`git clone <your-clone-url> && cd webpack.js.org`
11
-
*`git checkout develop`
12
11
*`npm install`
13
12
*`npm run build`
14
13
*`npm start`
@@ -22,55 +21,26 @@ Run `git config user.email` to see your Git email, and verify it with [your GitH
22
21
23
22
## Editor Config
24
23
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.
30
25
31
26
## Branching Your Changes
32
27
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:
34
29
35
30
* It allows you to have multiple contributions in as PRs at once.
36
31
* It allows us to identify what your contribution is about from the branch name.
37
32
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:
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.
68
36
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.
70
40
71
41
## Contribution Recognition
72
42
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:
74
44
75
45
**example.md**
76
46
@@ -80,7 +50,7 @@ title: Some Example Page
80
50
contributors:
81
51
- TheLarkInn
82
52
- Sokra
83
-
- Bebraw
53
+
- bebraw
84
54
- Jhnns
85
55
- SpaceK33z
86
56
===
@@ -89,7 +59,7 @@ contributors:
89
59
90
60
```
91
61
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.
0 commit comments