Skip to content

Commit 26f4308

Browse files
ersachin3112ersachin3112
authored
docs: improving typos in ISSUE_TEMPLATE files (#282)
1 parent e55a7b3 commit 26f4308

File tree

7 files changed

+60
-43
lines changed

7 files changed

+60
-43
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
<!--
22
👉🏽 Need support, advice, or help? Don't open an issue!
3-
Head to StackOverflow or https://gitter.im/webpack/webpack.
3+
Head to GitHub Discussions(https://github.com/webpack/webpack/discussions) or Stack Overflow(https://stackoverflow.com/questions/tagged/webpack)
44
5-
Hey there!
5+
Hey there! 👋
66
7-
You arrived at this template because you felt none of the other options
8-
matched the kind of issue you'd like to report. Please use this opportunity to
9-
tell us about your particular type of issue so we can try to accommodate
10-
similar issues in the future.
7+
You arrived at this template because you felt none of the other options matched the kind of issue you'd like to report.
118
12-
PLEASE do note, if you're using this to report an issue already covered by the
13-
existing template types, your issue may be closed as invalid. Our issue
14-
templates contain fields that help us help you, and without that important
9+
Please use this opportunity to tell us about your particular type of issue so we can try to accommodate similar issues in the future.
10+
11+
PLEASE do note, if you're using this to report an issue already covered by the existing template types, your issue may be closed as invalid.
12+
13+
Our issue templates contain fields that help us help you, and without that important
1514
info, we might as well be ice-skating uphill, carrying a wooly mammoth.
1615
-->

‎.github/ISSUE_TEMPLATE/BUG.md‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,31 @@ name: 🐛 Bug Report
33
about: Something went awry and you'd like to tell us about it.
44
---
55

6-
<!-- Please don't delete this template otherwise your issue will be closed immediately -->
7-
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
6+
<!-- Please do not delete this template, otherwise your issue may be closed immediately. -->
7+
<!-- Before creating an issue, make sure you are using the latest version of webpack. -->
88

99
### Bug report
1010

11-
<!-- Please ask questions on discussions or StackOverflow. -->
11+
<!-- Please ask questions in Discussions or on Stack Overflow. -->
1212
<!-- https://github.com/webpack/webpack/discussions -->
1313
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
14-
<!-- Issues which contain questions or support requests will be closed. -->
14+
<!-- Issues that contain questions or support requests will be closed. -->
1515

1616
### Actual Behavior
1717

18-
<!-- Explain exactly how it behave -->
18+
<!-- Explain exactly how it behaves. -->
1919

2020
### Expected Behavior
2121

22-
<!-- "It should work" is not a helpful explanation -->
23-
<!-- Explain exactly how it should behave -->
22+
<!-- "It should work" is not a helpful explanation. -->
23+
<!-- Explain exactly how it should behave. -->
2424

2525
### How Do We Reproduce?
2626

27-
<!-- A great way to do this is to provide your configuration via a GitHub repository -->
28-
<!-- The most helpful is a minimal reproduction with instructions on how to reproduce -->
29-
<!-- Repositories with too many files or large `webpack.config.js` files are not suitable -->
30-
<!-- Please only add small code snippets directly into this issue -->
31-
<!-- https://gist.github.com is a good place for longer code snippets -->
32-
<!-- If your issue is caused by a plugin or loader, please create an issue on the loader/plugin repository instead -->
27+
<!-- A great way to do this is to provide your configuration via a GitHub repository. -->
28+
<!-- Minimal reproductions with clear instructions on how to reproduce are the most helpful. -->
29+
<!-- Repositories with too many files or large `webpack.config.js` files are not suitable. -->
30+
<!-- Please include only small code snippets directly in this issue. -->
31+
<!-- If your issue is caused by a plugin or loader, please create an issue in the corresponding repository instead. -->
3332

34-
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information
33+
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.

‎.github/ISSUE_TEMPLATE/DOCS.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ name: 📚 Documentation
33
about: Are the docs lacking or missing something? Do they need some new 🔥 hotness? Tell us here.
44
---
55

6-
<!-- Please don't delete this template otherwise your issue will be closed immediately -->
7-
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
6+
<!-- Please do not delete this template, otherwise your issue will be closed immediately. -->
7+
<!-- Before creating an issue, make sure you are using the latest version of webpack. -->
88

9-
Documentation Is:
9+
Documentation is:
1010

11-
<!-- Please place an x (no spaces!) in all [ ] that apply -->
11+
<!-- Please place an "x" (no spaces!) in all [ ] that apply -->
1212

1313
- [ ] Missing
1414
- [ ] Needed
@@ -17,9 +17,9 @@ Documentation Is:
1717

1818
### Please Explain in Detail...
1919

20-
<!-- Please don't delete this template otherwise your issue will be closed immediately -->
20+
<!-- Please ask questions in Discussions or on Stack Overflow. -->
2121
<!-- https://github.com/webpack/webpack/discussions -->
2222
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
23-
<!-- Issues which contain questions or support requests will be closed. -->
23+
<!-- Issues that contain questions or support requests will be closed. -->
2424

2525
### Your Proposal for Changes

‎.github/ISSUE_TEMPLATE/FEATURE.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,18 @@ name: ✨ Feature Request
33
about: Suggest an idea for this project
44
---
55

6-
<!-- Please don't delete this template otherwise your issue will be closed immediately -->
7-
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
6+
<!-- Please do not delete this template, otherwise your issue may be closed immediately. -->
7+
<!-- Before creating an issue, make sure you are using the latest version of webpack. -->
88

99
### Feature Proposal
1010

11-
<!-- Please ask questions on discussions or StackOverflow. -->
11+
<!-- Please ask questions in Discussions or on Stack Overflow. -->
1212
<!-- https://github.com/webpack/webpack/discussions -->
1313
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
14-
<!-- Issues which contain questions or support requests will be closed. -->
14+
<!-- Issues that contain questions or support requests will be closed. -->
1515

1616
### Feature Use Case
1717

18-
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information
18+
<!-- Describe the problem this feature would solve and how it would be used in practice. -->
19+
20+
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.

‎.github/ISSUE_TEMPLATE/MODIFICATION.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
---
22
name: 🔧 Modification Request
3-
about: Would you like something work differently? Have an alternative approach? This is the template for you.
3+
about: Want something to work differently? Have an alternative approach? This is the template for you.
44
---
55

6-
<!-- Please don't delete this template otherwise your issue will be closed immediately -->
7-
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
6+
<!-- Please do not delete this template, otherwise your issue may be closed immediately. -->
7+
<!-- Before creating an issue, please make sure you are using the latest version of webpack. -->
88

99
### Modification Proposal
1010

11-
<!-- Please ask questions on discussions or StackOverflow. -->
11+
<!-- Clearly describe the change you are proposing and why it's necessary. -->
12+
<!-- Please ask questions in Discussions or on Stack Overflow. -->
1213
<!-- https://github.com/webpack/webpack/discussions -->
1314
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
14-
<!-- Issues which contain questions or support requests will be closed. -->
15+
<!-- Issues that contain questions or support requests will be closed. -->
1516

1617
### Expected Behavior / Situation
1718

19+
<!-- Describe how you expect the feature or behavior to work. -->
20+
1821
### Actual Behavior / Situation
1922

20-
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information
23+
<!-- Describe how it currently works or behaves. -->
24+
25+
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.

‎.github/ISSUE_TEMPLATE/SUPPORT.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
---
22
name: 🆘 Support, Help, and Advice
3-
about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to https://github.com/webpack/webpack/discussions or StackOverflow.
3+
about: 👉🏽 Need support, help, or advice? Don't open an issue - visit "GitHub Discussions" or "Stack Overflow" instead.
44
---
55

6-
Hey there! If you need support, help, or advice then this is not the place to ask.
7-
Please visit [GitHub Discussions](https://github.com/webpack/webpack/discussions) or [StackOverflow](https://stackoverflow.com/questions/tagged/webpack) instead.
6+
Hey there! 👋
7+
8+
If you need support, help, or advice then this is not the right place to ask.
9+
10+
Please visit one of the following instead:
11+
12+
- [GitHub Discussions](https://github.com/webpack/webpack/discussions)
13+
- [Stack Overflow](https://stackoverflow.com/questions/tagged/webpack)
14+
15+
Thanks for understanding!

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ type eslintPath = string;
146146
- Default: `eslint`
147147

148148
Path to `eslint` instance that will be used for linting.
149+
149150
If the `eslintPath` is a folder like a official ESlint, or specify a `formatter` option, now you don't have to install `eslint`.
150151

151152
### `extensions`
@@ -226,6 +227,7 @@ type formatter = string| (
226227
- Default: `'stylish'`
227228
228229
Accepts a function that receives an array of ESLint messages (object) as its argument and must return a string as output.
230+
229231
You can use official [ESlint formatters](https://eslint.org/docs/user-guide/formatters/).
230232
231233
### `lintDirtyModulesOnly`
@@ -255,6 +257,7 @@ Will run lint tasks across a thread pool. The pool size is automatic unless you
255257
### Errors and Warning
256258

257259
**By default the plugin will auto adjust error reporting depending on eslint errors/warnings counts.**
260+
258261
You can still force this behavior by using `emitError` **or** `emitWarning` options:
259262

260263
#### `emitError`
@@ -353,6 +356,7 @@ Write ESLint results to a file, for example a checkstyle xml file for use for re
353356
## Contributing
354357

355358
We welcome all contributions!
359+
356360
If you're new here, please take a moment to review our contributing guidelines.
357361

358362
[CONTRIBUTING](./.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)