docs: fix typos and improve clarity in contribution guidelines #799

ersachin3112 · 2025-05-17T05:08:24Z

This PR contains a:

Motivation / Use-Case

fix typos and improve clarity in contribution guidelines, corrected grammatical issues, improved sentence structure, and refined formatting across the contribution guidelines in README.md

Breaking Changes

No

Additional Info

No

codecov · 2025-05-17T05:09:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.66%. Comparing base (a20dedd) to head (badcaa8).
Report is 22 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #799      +/-   ##
==========================================
+ Coverage   90.55%   91.66%   +1.10%     
==========================================
  Files           2        2              
  Lines         413      408       -5     
  Branches      120      112       -8     
==========================================
  Hits          374      374              
+ Misses         38       33       -5     
  Partials        1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

snitin315 · 2025-05-18T03:18:07Z

.github/CONTRIBUTING.md

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

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


Suggested change

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.

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.

snitin315 · 2025-05-18T03:18:45Z

.github/CONTRIBUTING.md

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

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


Suggested change

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:

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:

snitin315 · 2025-05-18T03:20:23Z

.github/CONTRIBUTING.md

 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.

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


Suggested change

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.

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.

snitin315 · 2025-05-18T03:20:40Z

.github/CONTRIBUTING.md

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

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


Suggested change

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.

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.

snitin315 · 2025-05-18T03:21:10Z

.github/CONTRIBUTING.md

 You can _request_ a new feature by creating an issue on Github.

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


Suggested change

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.

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.

snitin315 · 2025-05-18T03:22:33Z

.github/CONTRIBUTING.md

+- Search Github for an open or closed PR related to your submission to avoid duplicating effort.
+- 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.
+- Complete the `Pull Request Template`. Pull requests that ignore the template will not be reviewed.
+- 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.


Suggested change

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

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

snitin315 · 2025-05-18T03:23:18Z

.github/CONTRIBUTING.md

-You may have the need to test your changes in a real-world project or dependent
-module. Thankfully, Github provides a means to do this. Add a dependency to the
-`package.json` for such a project as follows:
+You may need to test your changes in a real-world project or dependent


Suggested change

You may need to test your changes in a real-world project or dependent

You may need to test your changes in a real-world project or a dependent

snitin315 · 2025-05-18T03:23:27Z

.github/CONTRIBUTING.md

-module. Thankfully, Github provides a means to do this. Add a dependency to the
-`package.json` for such a project as follows:
+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:


Suggested change

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:

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:

ersachin3112 · 2025-05-18T03:32:30Z

Ok Sure, I agree with the changes you made. I am fixing it all

docs: fix typos and improve clarity in contribution guidelines

adf2c76

ersachin3112 added 2 commits May 17, 2025 10:59

docs: fix typos and improve clarity in contribution guidelines

c192e59

docs: fix typos and improve clarity in contribution guidelines

e3bb40b

snitin315 reviewed May 18, 2025

View reviewed changes

docs: fix typos and improve clarity in contribution guidelines

badcaa8

snitin315 approved these changes May 18, 2025

View reviewed changes

snitin315 merged commit e4fd967 into webpack:master May 18, 2025
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: fix typos and improve clarity in contribution guidelines #799

docs: fix typos and improve clarity in contribution guidelines #799

Uh oh!

ersachin3112 commented May 17, 2025 •

edited

Loading

Uh oh!

codecov bot commented May 17, 2025 •

edited

Loading

Uh oh!

snitin315 May 18, 2025

Uh oh!

snitin315 May 18, 2025

Uh oh!

snitin315 May 18, 2025

Uh oh!

snitin315 May 18, 2025

Uh oh!

snitin315 May 18, 2025 •

edited

Loading

Uh oh!

snitin315 May 18, 2025

Uh oh!

snitin315 May 18, 2025

Uh oh!

snitin315 May 18, 2025

Uh oh!

ersachin3112 commented May 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

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

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

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

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

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

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

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

Uh oh!

docs: fix typos and improve clarity in contribution guidelines #799

docs: fix typos and improve clarity in contribution guidelines #799

Uh oh!

Conversation

ersachin3112 commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation / Use-Case

Breaking Changes

Additional Info

Uh oh!

codecov bot commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

snitin315 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

snitin315 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

snitin315 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

snitin315 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

snitin315 May 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

snitin315 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

snitin315 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

snitin315 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

ersachin3112 commented May 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ersachin3112 commented May 17, 2025 •

edited

Loading

codecov bot commented May 17, 2025 •

edited

Loading

snitin315 May 18, 2025 •

edited

Loading