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: .github/CONTRIBUTING.md
+22-26Lines changed: 22 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,34 +17,34 @@ The issue tracker is for bug reports and feature discussions.
17
17
18
18
##<aname="issue"></a> Found an Issue or Bug?
19
19
20
-
Before you submit an issue, please search the issue tracker,maybean issue for your problem alreadyexists and the discussion might inform you of workarounds readily available.
20
+
Before you submit an issue, please search the issue tracker, an issue for your problemmayalreadyexist, and the discussion might inform you of workarounds readily available.
21
21
22
-
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we ask that youtoprovide a minimal reproduction scenario (github repo or failing test case). Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:
22
+
We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we ask that you provide a minimal reproduction scenario (GitHub repo or failing test case). Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:
23
23
24
24
- version of Webpack used
25
25
- version of the loader / plugin you are creating a bug report for
26
26
- the use-case that fails
27
27
28
28
A minimal reproduce scenario allows us to quickly confirm a bug (or point out config problems) as well as confirm that we are fixing the right problem.
29
29
30
-
We will be insisting on a minimalreproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extractessentials bits of code from a largercode-base but we really need to isolate the problem before we can fix it.
30
+
We will be insisting on a minimalreproduction scenario in order to savethemaintainers' time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extractessential bits of code from a largercodebase, but we really need to isolate the problem before we can fix it.
31
31
32
-
Unfortunately, we arenot ableto investigate/ fix bugs without a minimal reproduction, so if we don't hear back from you weare going to close an issue that doesn't have enough info to be reproduced.
32
+
Unfortunately, we areunableto investigateor fix bugs without a minimal reproduction, so if we don't hear back from you, wemay have to close an issue that doesn't have enough info to be reproduced.
33
33
34
34
##<aname="feature"></a> Feature Requests?
35
35
36
-
You can_request_ a new feature by creating an issue onGithub.
36
+
You can_request_ a new feature by creating an issue onGitHub.
37
37
38
-
If you would like to_implement_ a new feature, please submit an issue with a proposalfor your work`first`,tobe sure that particular makes sense for the project.
38
+
If you would like to_implement_ a new feature yourself, please**firstsubmit an issue** with a proposal toensure the idea aligns with the goals of the project.
Before you submit your Pull Request (PR) consider the following guidelines:
43
43
44
-
- SearchGithub for an open or closed PRthat relatesto your submission. You don't wanttoduplicate effort.
45
-
- Commit your changes using a descriptive commit message that follows our[commit message conventions](#commit).Adherence to these conventionsisnecessary because release notes are automatically generated from these messages.
46
-
-Fill out our`Pull Request Template`.Your pull requestwill not beconsidered if it is ignored.
47
-
- Please sign the`Contributor License Agreement (CLA)` whena pull request is opened. We cannot accept yourpull requestwithoutthis. Make sureyou signwith the primary email address associated with your local/ github account.
44
+
- SearchGitHub for an open or closed PRrelatedto your submissiontoavoid duplicating effort.
45
+
- Commit your changes using a descriptive commit message that follows our[commit message conventions](#commit).Thisisimportant because release notes are automatically generated from these messages.
46
+
-Complete the`Pull Request Template`.Pull requests that ignore the templatewill not bereviewed.
47
+
- Please sign the`Contributor License Agreement (CLA)` whenyou open your pull request. We cannot accept yourcontributionwithoutit. Be sureto signusing the primary email address associated with your localand GitHub account.
@@ -61,8 +61,7 @@ format that includes a **type**, a **scope** and a **subject**:
61
61
62
62
The**header** is mandatory and the**scope** of the header is optional.
63
63
64
-
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
65
-
to read on GitHub as well as in various git tools.
64
+
No line in the commit message should exceed 100 characters! This makes the message easier to read on GitHub as well as in various Git tools.
66
65
67
66
The footer should contain a[closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
68
67
@@ -83,7 +82,7 @@ In the body it should say: `This reverts commit <hash>.`, where the hash is the
83
82
84
83
###Type
85
84
86
-
Must be one of the following:
85
+
Must be one of the following commit types:
87
86
88
87
-**build**: Changes that affect the build system or external dependencies (example scopes: babel, npm)
89
88
-**chore**: Changes that fall outside of build / docs that do not effect source code (example scopes: package, defaults)
@@ -99,27 +98,26 @@ Must be one of the following:
99
98
100
99
###Scope
101
100
102
-
The scope is subjective & depends on the`type` see above. A good example would be a change to a particular class/ module.
101
+
The scope is subjective & depends on the`type` see above. A good exampleof a scopewould be a change to a particular classor module.
103
102
104
103
###Subject
105
104
106
105
The subject contains a succinct description of the change:
107
106
108
-
- use the imperative, present tense: "change" not "changed"nor "changes"
107
+
- use the imperative, present tense: "change" not "changed"or "changes"
109
108
- don't capitalize the first letter
110
109
- no dot (.) at the end
111
110
112
111
###Body
113
112
114
-
Just as in the**subject**, use the imperative, present tense: "change" not "changed"nor "changes".
115
-
The body should include the motivation for the change and contrastthis with previous behavior.
113
+
Just as in the**subject**, use the imperative, present tense: "change" not "changed"or "changes".
114
+
The body should include the motivation for the change and contrastit with previous behavior.
116
115
117
116
###Footer
118
117
119
-
The footer should contain any information about**Breaking Changes** and is also the place to
120
-
reference GitHub issues that this commit**Closes**.
118
+
The footer should include any information about**Breaking Changes** and is also the place to reference GitHub issues that this commit**Closes**.
121
119
122
-
**Breaking Changes**should start with the word`BREAKING CHANGE:`witha space or twonewlines. The rest of thecommit message is then used for this.
120
+
**Breaking Changes**must start with the word`BREAKING CHANGE:`followed bya space or twonew lines. The rest of thebreaking change details should be provided after this.
123
121
124
122
Example
125
123
@@ -133,9 +131,7 @@ Migration: see webpack/webpack#5225
133
131
134
132
##Testing Your Pull Request
135
133
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
138
-
`package.json` for such a project as follows:
134
+
You may need to test your changes in a real-world project or a dependent module. Thankfully, GitHub provides a means to do this. To add a dependency to the`package.json` of such a project, use the following syntax:
139
135
140
136
```json
141
137
{
@@ -149,11 +145,11 @@ Where `{id}` is the # ID of your Pull Request.
149
145
150
146
##Contributor License Agreement
151
147
152
-
When submitting your contribution, a CLA (Contributor License Agreement) bot willcome by toverifythat you signed the[CLA](https://easycla.lfx.linuxfoundation.org/#/?version=2).
148
+
When submitting your contribution, a CLA (Contributor License Agreement) bot will verifywhether you have signed the[CLA](https://easycla.lfx.linuxfoundation.org/#/?version=2).
153
149
If it is your first time, it will link you to the right place to sign it.
154
-
However, ifyou have committedyourcontributions using an email that is notthesame as youremailused onGitHub, the CLA botcan't accept your contribution.
150
+
However, ifthe email used inyourcommits doesn’t matchthe emailassociated with yourGitHub account, the CLA botwon’t accept your contribution.
155
151
156
-
Run`git config user.email` to see your Git email, and verify it with[your GitHub email](https://github.com/settings/emails).
152
+
Run`Git config user.email` to see your Git email, and verify it with[your GitHub email](https://github.com/settings/emails).