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
+21-22Lines changed: 21 additions & 22 deletions
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, maybe an issue for your problem already exists 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 problem may already exist 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 you to 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:
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 minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
30
+
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.
31
31
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.
32
+
Unfortunately, we are unable to investigate or fix bugs without a minimal reproduction, so if we don't hear back from you we may 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
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 yourself, please `first`submit an issue with a proposal to ensure the idea aligns with the goals of the project.
Before you submit your Pull Request (PR) consider the following guidelines:
43
43
44
-
- Search Github for an open or closed PR that relates to your submission. You don't want to duplicate effort.
45
-
- Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages.
46
-
-Fill out our `Pull Request Template`. Your pull request will not be considered if it is ignored.
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.
44
+
- Search Github for an open or closed PR related to your submissionto avoid duplicating effort.
45
+
- Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). This is important because release notes are automatically generated from these messages.
46
+
-Complete the `Pull Request Template`.- Complete the `Pull Request Template`. Pull requests that ignore the template will not be reviewed.
47
+
- Please sign the `Contributor License Agreement (CLA)` when you open your pull request. We cannot accept your contribution without it. Be sure to sign using the primary email address associated with your local and github account.
@@ -61,7 +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
64
+
No line in the commit message should exceed 100 characters! This makes the message easier
65
65
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.
@@ -83,7 +83,7 @@ In the body it should say: `This reverts commit <hash>.`, where the hash is the
83
83
84
84
### Type
85
85
86
-
Must be one of the following:
86
+
Must be one of the following commit types:
87
87
88
88
-**build**: Changes that affect the build system or external dependencies (example scopes: babel, npm)
89
89
-**chore**: Changes that fall outside of build / docs that do not effect source code (example scopes: package, defaults)
@@ -99,27 +99,27 @@ Must be one of the following:
99
99
100
100
### Scope
101
101
102
-
The scope is subjective & depends on the `type` see above. A good example would be a change to a particular class / module.
102
+
The scope is subjective & depends on the `type` see above. A good example of a scope would be a change to a particular class or module.
103
103
104
104
### Subject
105
105
106
106
The subject contains a succinct description of the change:
107
107
108
-
- use the imperative, present tense: "change" not "changed" nor "changes"
108
+
- use the imperative, present tense: "change" not "changed" or "changes"
109
109
- don't capitalize the first letter
110
110
- no dot (.) at the end
111
111
112
112
### Body
113
113
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 contrast this with previous behavior.
114
+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" or "changes".
115
+
The body should include the motivation for the change and contrast it with previous behavior.
116
116
117
117
### Footer
118
118
119
-
The footer should contain any information about **Breaking Changes** and is also the place to
119
+
The footer should include any information about **Breaking Changes** and is also the place to
120
120
reference GitHub issues that this commit **Closes**.
121
121
122
-
**Breaking Changes**should start with the word `BREAKING CHANGE:`with a space or two newlines. The rest of the commit message is then used for this.
122
+
**Breaking Changes**must start with the word `BREAKING CHANGE:`followed by a space or two newlines. The rest of the breaking change details should be provided after this.
123
123
124
124
Example
125
125
@@ -133,9 +133,8 @@ Migration: see webpack/webpack#5225
133
133
134
134
## Testing Your Pull Request
135
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
138
-
`package.json` for such a project as follows:
136
+
You may need to test your changes in a real-world project or dependent
137
+
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
138
140
139
```json
141
140
{
@@ -149,9 +148,9 @@ Where `{id}` is the # ID of your Pull Request.
149
148
150
149
## Contributor License Agreement
151
150
152
-
When submitting your contribution, a CLA (Contributor License Agreement) bot will come by to verify that you signed the [CLA](https://easycla.lfx.linuxfoundation.org/#/?version=2).
151
+
When submitting your contribution, a CLA (Contributor License Agreement) bot will verify whether you have signed the [CLA](https://easycla.lfx.linuxfoundation.org/#/?version=2).
153
152
If it is your first time, it will link you to the right place to sign it.
154
-
However, if you have committed your contributions using an email that is not the same as your email used on GitHub, the CLA bot can't accept your contribution.
153
+
However, if the email used in your commits doesn’t match the email associated with your GitHub account, the CLA bot won’t accept your contribution.
155
154
156
155
Run `git config user.email` to see your Git email, and verify it with [your GitHub email](https://github.com/settings/emails).
0 commit comments