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
+13-20Lines changed: 13 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,34 +11,27 @@ Most of the time, if webpack is not working correctly for you it is a simple con
11
11
12
12
If you are still having difficulty after looking over your configuration carefully, please post
13
13
a question to [StackOverflow with the webpack tag](http://stackoverflow.com/tags/webpack). Questions
14
-
that include your webpack.config.js and relevant files are more likely to receive responses.
14
+
that include your webpack.config.js, relevant files, and the full error message are more likely to receive responses.
15
15
16
16
**If you have discovered a bug or have a feature suggestion, please [create an issue on GitHub](https://github.com/webpack/webpack/issues/new).**
17
17
18
-
## Contributing to the webpack ecosystem
18
+
Do you want to fix an issue? Look at the issues with a tag of [X5: work required (PR / Help Wanted)](https://github.com/webpack/webpack/labels/X5%3A%20work%20required%20%28PR%20%2F%20Help%20Wanted%29). Each issue should be tagged with a difficulty tag -
19
19
20
-
If you have created your own loader/plugin please include it on the relevant
21
-
documentation pages:
20
+
- D0: My First Commit (Contribution Difficulty)
21
+
- D1: Easy (Contribution Difficulty)
22
+
- D2: Medium (Contribution Difficulty)
23
+
- D3: Hard (Contribution Difficulty)
22
24
23
-
[List of loaders](https://webpack.js.org/loaders/) or [awesome-webpack](https://github.com/webpack-contrib/awesome-webpack#loaders)
24
-
[List of plugins](https://webpack.js.org/plugins) or [awesome-webpack](https://github.com/webpack-contrib/awesome-webpack#webpack-plugins)
25
+
## Contributing to the webpack ecosystem
25
26
26
-
## Setup
27
+
If you have created your own loader/plugin please include it on the relevant documentation pages:
27
28
28
-
```bash
29
-
git clone https://github.com/webpack/webpack.git
30
-
cd webpack
31
-
npm install -g yarn
32
-
yarn install
33
-
yarn link
34
-
yarn link webpack
35
-
```
29
+
-[List of loaders](https://webpack.js.org/loaders/) or [awesome-webpack](https://github.com/webpack-contrib/awesome-webpack#loaders)
30
+
-[List of plugins](https://webpack.js.org/plugins) or [awesome-webpack](https://github.com/webpack-contrib/awesome-webpack#webpack-plugins)
36
31
37
-
To run the entire test suite use:
32
+
## Setup
38
33
39
-
```bash
40
-
yarn test
41
-
```
34
+
[Setup your local webpack repository](_SETUP.md)
42
35
43
36
## Submitting Changes
44
37
@@ -56,7 +49,7 @@ Some things that will increase the chance that your pull request is accepted:
56
49
57
50
webpack is insanely feature rich and documentation is a huge time sink. We
58
51
greatly appreciate any time spent fixing typos or clarifying sections in the
59
-
documentation.
52
+
documentation.[See a list of issues with the documentation tag.](https://github.com/webpack/webpack/labels/documentation)
webpack is a module bundler. Its main purpose is to bundle JavaScript files for usage in a browser, yet it is also capable of transforming, bundling, or packaging just about any resource or asset.
36
-
<p>
36
+
</p>
37
37
</div>
38
38
39
39
<h2align="center">Install</h2>
@@ -52,15 +52,15 @@ yarn add webpack --dev
52
52
53
53
<h2align="center">Introduction</h2>
54
54
55
-
> This README reflects Webpack v2.x and v3.x. The Webpack v1.x documentation has been deprecated and deleted.
55
+
> This README reflects webpack v2.x and v3.x. The webpack v1.x documentation has been deprecated and deleted.
56
56
57
57
webpack is a bundler for modules. The main purpose is to bundle JavaScript
58
58
files for usage in a browser, yet it is also capable of transforming, bundling,
59
59
or packaging just about any resource or asset.
60
60
61
61
**TL;DR**
62
62
63
-
* Bundles [ES Modules](http://www.2ality.com/2014/09/es6-modules-final.html), [CommonJS](http://wiki.commonjs.org/) and [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD) modules (even combined).
63
+
* Bundles [ES Modules](http://www.2ality.com/2014/09/es6-modules-final.html), [CommonJS](http://wiki.commonjs.org/), and [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD) modules (even combined).
64
64
* Can create a single bundle or multiple chunks that are asynchronously loaded at runtime (to reduce initial loading time).
65
65
* Dependencies are resolved during compilation, reducing the runtime size.
66
66
* Loaders can preprocess files while compiling, e.g. TypeScript to JavaScript, Handlebars strings to compiled functions, images to Base64, etc.
@@ -70,6 +70,11 @@ or packaging just about any resource or asset.
70
70
71
71
Check out webpack's quick [**Get Started**](https://webpack.js.org/get-started/) guide and the [other guides](https://webpack.js.org/guides/).
72
72
73
+
### Browser Compatibility
74
+
75
+
webpack supports all browsers that are [ES5-compliant](http://kangax.github.io/compat-table/es5/) (IE8 and below are not supported).
76
+
webpack also needs `Promise` for `import()` and `require.ensure()`. If you want to support older browsers, you will need to [load a polyfill](https://webpack.js.org/guides/shimming/) before using these expressions.
77
+
73
78
<h2align="center">Concepts</h2>
74
79
75
80
### [Plugins](https://webpack.js.org/plugins/)
@@ -81,14 +86,12 @@ within webpack itself use this plugin interface. This makes webpack very
81
86
82
87
|Name|Status|Description|
83
88
|:--:|:----:|:----------|
84
-
|[common-chunks-webpack-plugin][common]|![common-npm]|Generates chunks of common modules shared between entry points and splits them into separate bundles (e.g vendor.bundle.js && app.bundle.js)|
85
89
|[extract-text-webpack-plugin][extract]|![extract-npm]|Extracts Text (CSS) from your bundles into a separate file (app.bundle.css)|
86
90
|[compression-webpack-plugin][compression]|![compression-npm]|Prepares compressed versions of assets to serve them with Content-Encoding|
87
91
|[i18n-webpack-plugin][i18n]|![i18n-npm]|Adds i18n support to your bundles|
88
92
|[html-webpack-plugin][html-plugin]|![html-plugin-npm]| Simplifies creation of HTML files (`index.html`) to serve your bundles|
@@ -184,7 +187,7 @@ or are automatically applied via regex from your webpack configuration.
184
187
185
188
|Name|Status|Description|
186
189
|:--:|:----:|:----------|
187
-
|<ahref="https://github.com/webpack/style-loader">`<style>`|![style-npm]|Add exports of a module as style to DOM|
190
+
|<ahref="https://github.com/webpack/style-loader">`<style>`</a>|![style-npm]|Add exports of a module as style to DOM|
188
191
|<ahref="https://github.com/webpack/css-loader"><imgwidth="48"height="48"src="https://worldvectorlogo.com/logos/css-3.svg"></a>|![css-npm]|Loads CSS file with resolved imports and returns CSS code|
189
192
|<ahref="https://github.com/webpack/less-loader"><imgwidth="48"height="48"src="https://worldvectorlogo.com/logos/less-63.svg"></a>|![less-npm]|Loads and compiles a LESS file|
190
193
|<ahref="https://github.com/jtangelder/sass-loader"><imgwidth="48"height="48"src="https://worldvectorlogo.com/logos/sass-1.svg"></a>|![sass-npm]|Loads and compiles a SASS/SCSS file|
@@ -326,25 +329,13 @@ If you have discovered a 🐜 or have a feature suggestion, feel free to create
@@ -382,11 +373,11 @@ This is how we use the donations:
382
373
Before we started using OpenCollective, donations were made anonymously. Now that we have made the switch, we would like to acknowledge these sponsors (and the ones who continue to donate using OpenCollective). If we've missed someone, please send us a PR, and we'll add you to this list.
0 commit comments