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
{{ message }}
This repository was archived by the owner on Mar 17, 2021. It is now read-only.
We'd always love contributions to further improve the webpack / webpack-contrib ecosystem!
3
+
We'd always love contributions to further improve the webpack / webpack-contrib ecosystem!
4
4
Here are the guidelines we'd like you to follow:
5
5
6
-
*[Questions and Problems](#question)
7
-
*[Issues and Bugs](#issue)
8
-
*[Feature Requests](#feature)
9
-
*[Pull Request Submission Guidelines](#submit-pr)
10
-
*[Commit Message Conventions](#commit)
6
+
-[Questions and Problems](#question)
7
+
-[Issues and Bugs](#issue)
8
+
-[Feature Requests](#feature)
9
+
-[Pull Request Submission Guidelines](#submit-pr)
10
+
-[Commit Message Conventions](#commit)
11
11
12
-
###<aname="question"></a> Got a Question or Problem?
12
+
## <aname="question"></a> Got a Question or Problem?
13
13
14
-
Please submit support requests and questions to StackOverflow using the tag [[webpack]](http://stackoverflow.com/tags/webpack).
15
-
StackOverflow is better suited for this kind of support though you may also inquire in [Webpack Gitter](https://gitter.im/webpack/webpack).
14
+
Please submit support requests and questions to StackOverflow using the tag [[webpack]](http://stackoverflow.com/tags/webpack).
15
+
StackOverflow is better suited for this kind of support though you may also inquire in [Webpack Gitter](https://gitter.im/webpack/webpack).
16
16
The issue tracker is for bug reports and feature discussions.
17
17
18
-
###<aname="issue"></a> Found an Issue or Bug?
18
+
## <aname="issue"></a> Found an Issue or Bug?
19
19
20
20
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
21
21
@@ -31,13 +31,13 @@ We will be insisting on a minimal reproduce scenario in order to save maintainer
31
31
32
32
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.
33
33
34
-
###<aname="feature"></a> Feature Requests?
34
+
## <aname="feature"></a> Feature Requests?
35
35
36
-
You can *request* a new feature by creating an issue on Github.
36
+
You can _request_ a new feature by creating an issue on Github.
37
37
38
-
If you would like to *implement* a new feature, please submit an issue with a proposal for your work `first`, to be sure that particular makes sense for the project.
38
+
If you would like to _implement_ a new feature, please submit an issue with a proposal for your work `first`, to be sure that particular makes sense for the project.
Before you submit your Pull Request (PR) consider the following guidelines:
43
43
@@ -46,9 +46,9 @@ Before you submit your Pull Request (PR) consider the following guidelines:
46
46
- Fill out our `Pull Request Template`. Your pull request will not be considered if it is ignored.
47
47
- Please sign the `Contributor License Agreement (CLA)` when a pull request is opened. We cannot accept your pull request without this. Make sure you sign with the primary email address associated with your local / github account.
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
51
+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
52
52
format that includes a **type**, a **scope** and a **subject**:
53
53
54
54
```
@@ -66,48 +66,56 @@ to read on GitHub as well as in various git tools.
66
66
67
67
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
68
68
69
-
Examples:
69
+
Examples:
70
+
70
71
```
71
72
docs(readme): update install instructions
72
73
```
74
+
73
75
```
74
76
fix: refer to the `entrypoint` instead of the first `module`
75
77
```
76
78
77
-
#### Revert
78
-
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
79
+
### Revert
80
+
81
+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit.
79
82
In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
80
83
81
-
#### Type
84
+
### Type
85
+
82
86
Must be one of the following:
83
87
84
-
***build**: Changes that affect the build system or external dependencies (example scopes: babel, npm)
85
-
***chore**: Changes that fall outside of build / docs that do not effect source code (example scopes: package, defaults)
86
-
***ci**: Changes to our CI configuration files and scripts (example scopes: circleci, travis)
87
-
***docs**: Documentation only changes (example scopes: readme, changelog)
88
-
***feat**: A new feature
89
-
***fix**: A bug fix
90
-
***perf**: A code change that improves performance
91
-
***refactor**: A code change that neither fixes a bug nor adds a feature
92
-
***revert**: Used when reverting a committed change
93
-
***style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
94
-
***test**: Addition of or updates to Jest tests
95
-
96
-
#### Scope
88
+
-**build**: Changes that affect the build system or external dependencies (example scopes: babel, npm)
89
+
-**chore**: Changes that fall outside of build / docs that do not effect source code (example scopes: package, defaults)
90
+
-**ci**: Changes to our CI configuration files and scripts (example scopes: circleci, travis)
91
+
-**docs**: Documentation only changes (example scopes: readme, changelog)
92
+
-**feat**: A new feature
93
+
-**fix**: A bug fix
94
+
-**perf**: A code change that improves performance
95
+
-**refactor**: A code change that neither fixes a bug nor adds a feature
96
+
-**revert**: Used when reverting a committed change
97
+
-**style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
98
+
-**test**: Addition of or updates to Jest tests
99
+
100
+
### Scope
101
+
97
102
The scope is subjective & depends on the `type` see above. A good example would be a change to a particular class / module.
98
103
99
-
#### Subject
104
+
### Subject
105
+
100
106
The subject contains a succinct description of the change:
101
107
102
-
* use the imperative, present tense: "change" not "changed" nor "changes"
103
-
* don't capitalize the first letter
104
-
* no dot (.) at the end
108
+
- use the imperative, present tense: "change" not "changed" nor "changes"
109
+
- don't capitalize the first letter
110
+
- no dot (.) at the end
111
+
112
+
### Body
105
113
106
-
#### Body
107
114
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
108
115
The body should include the motivation for the change and contrast this with previous behavior.
109
116
110
-
#### Footer
117
+
### Footer
118
+
111
119
The footer should contain any information about **Breaking Changes** and is also the place to
112
120
reference GitHub issues that this commit **Closes**.
113
121
@@ -116,9 +124,29 @@ reference GitHub issues that this commit **Closes**.
116
124
Example
117
125
118
126
```
119
-
BREAKING CHANGE: Updates to `Chunk.mapModules`.
127
+
BREAKING CHANGE: Updates to `Chunk.mapModules`.
120
128
121
129
This release is not backwards compatible with `Webpack 2.x` due to breaking changes in webpack/webpack#4764
122
130
Migration: see webpack/webpack#5225
123
131
124
132
```
133
+
134
+
## Testing Your Pull Request
135
+
136
+
You may have the need to test your changes in a real-world project or dependent
137
+
module. Thankfully, Github provides a means to do this. Add a dependency to the
0 commit comments