Skip to content

Commit 1a8f091

Browse files
committed
docs: fix typos and improve clarity in contribution guidelines
1 parent b86a8b0 commit 1a8f091

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

.github/CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,34 @@ The issue tracker is for bug reports and feature discussions.
1717

1818
## <a name="issue"></a> Found an Issue or Bug?
1919

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.
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.
2121

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:
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:
2323

2424
- version of Webpack used
2525
- version of the loader / plugin you are creating a bug report for
2626
- the use-case that fails
2727

2828
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.
2929

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.
30+
We will be insisting on a minimal reproduction scenario in order to save the 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.
3131

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.
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.
3333

3434
## <a name="feature"></a> Feature Requests?
3535

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.
3737

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.
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.
3939

4040
## <a name="submit-pr"></a> Pull Request Submission Guidelines
4141

4242
Before you submit your Pull Request (PR) consider the following guidelines:
4343

44-
- Search Github for an open or closed PR related to your submission to avoid duplicating effort.
44+
- Search GitHub for an open or closed PR related to your submission to avoid duplicating effort.
4545
- 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.
4646
- 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.
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.
4848

4949
## <a name="commit"></a> Webpack Contrib Commit Conventions
5050

@@ -132,7 +132,7 @@ Migration: see webpack/webpack#5225
132132

133133
## Testing Your Pull Request
134134

135-
You may need to test your changes in a real-world project or 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:
135+
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:
136136

137137
```json
138138
{

0 commit comments

Comments
 (0)