docs: fix typos and improve clarity in contribution guidelines#799
Merged
snitin315 merged 4 commits intowebpack:masterfrom May 18, 2025
Merged
docs: fix typos and improve clarity in contribution guidelines#799snitin315 merged 4 commits intowebpack:masterfrom
snitin315 merged 4 commits intowebpack:masterfrom
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. 🚀 New features to boost your workflow:
|
snitin315
reviewed
May 18, 2025
.github/CONTRIBUTING.md
Outdated
| ## <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. |
Member
There was a problem hiding this comment.
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
reviewed
May 18, 2025
.github/CONTRIBUTING.md
Outdated
| 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: |
Member
There was a problem hiding this comment.
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
reviewed
May 18, 2025
.github/CONTRIBUTING.md
Outdated
| 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. |
Member
There was a problem hiding this comment.
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
reviewed
May 18, 2025
.github/CONTRIBUTING.md
Outdated
| 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. |
Member
There was a problem hiding this comment.
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
reviewed
May 18, 2025
.github/CONTRIBUTING.md
Outdated
| 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. |
Member
There was a problem hiding this comment.
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
reviewed
May 18, 2025
.github/CONTRIBUTING.md
Outdated
| - 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. |
Member
There was a problem hiding this comment.
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
reviewed
May 18, 2025
.github/CONTRIBUTING.md
Outdated
| 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 |
Member
There was a problem hiding this comment.
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
reviewed
May 18, 2025
.github/CONTRIBUTING.md
Outdated
| 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: |
Member
There was a problem hiding this comment.
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: |
Contributor
Author
|
Ok Sure, I agree with the changes you made. I am fixing it all |
snitin315
approved these changes
May 18, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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