Skip to content

Commit a3e0e6d

Browse files
ersachin3112ersachin3112
authored
docs: improving typos in ISSUE_TEMPLATE files (#285)
1 parent 54f544b commit a3e0e6d

File tree

6 files changed

+60
-35
lines changed

6 files changed

+60
-35
lines changed

‎.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! Head to https://github.com/webpack/webpack/discussions or StackOverflow
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+
- [StackOverflow](https://stackoverflow.com/questions/tagged/webpack)
14+
15+
Thanks for understanding!

‎README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,13 @@ Finally, run Webpack using your preferred method.
9191
Why? Because CSS support only these source map types.
9292

9393
The plugin respects the [`devtool`](https://webpack.js.org/configuration/devtool/) setting and uses the `SourceMapDevToolPlugin` internally.
94+
9495
Using a supported `devtool` value enables source map generation.
96+
9597
Enabling the `columns` option in `SourceMapDevToolPlugin` also allows source map generation.
9698

9799
Use source maps to map error message locations to their original modules (note that this may slow down compilation).
100+
98101
If you use your own `minify` function please refer to the `minify` section for correct handling of source maps.
99102

100103
## Options
@@ -179,6 +182,7 @@ module.exports = {
179182
- Default: `true`
180183

181184
Use multi-process parallel running to improve the build speed.
185+
182186
The default number of concurrent runs: `os.cpus().length - 1` or `os.availableParallelism() - 1` (if this function is supported).
183187

184188
> ℹ️ Parallelization can speed up your build significantly and is therefore **highly recommended**.
@@ -228,8 +232,10 @@ module.exports = {
228232
- Default: `CssMinimizerPlugin.cssnanoMinify`
229233

230234
Overrides the default minify function.
235+
231236
By default, plugin uses [cssnano](https://github.com/cssnano/cssnano) package.
232-
This is useful when using or testing unpublished versions or forks.
237+
238+
> This is useful when using or testing unpublished versions or forks.
233239
234240
Possible options:
235241

@@ -271,6 +277,7 @@ module.exports = {
271277
#### `Array`
272278

273279
If an array of functions is passed to the `minify` option, the `minimizerOptions` must also be an array.
280+
274281
The function index in the `minify` array corresponds to the options object with the same index in the `minimizerOptions` array.
275282

276283
**webpack.config.js**
@@ -337,6 +344,7 @@ module.exports = {
337344
#### `Array`
338345

339346
The function index in the `minify` array corresponds to the options object with the same index in the `minimizerOptions` array.
347+
340348
If you use `minimizerOptions` like object, all `minify` function accept it.
341349

342350
> If parallelization is enabled, the packages in `minimizerOptions` must be referenced via strings (`packageName` or `require.resolve(packageName)`). In this case, we shouldn't use `require`/`import`.
@@ -362,6 +370,7 @@ module.exports = {
362370
- Default: `{ from: assetName }`
363371

364372
Allows filtering options [`processoptions`](https://postcss.org/api/#processoptions) for the cssnano.
373+
365374
The `parser`,` stringifier` and `syntax` can be either a function or a string indicating the module that will be imported.
366375

367376
> [!WARNING]
@@ -411,6 +420,7 @@ module.exports = {
411420
- Default: `() => true`
412421

413422
Filter css-minimizer warnings (By default [cssnano](https://github.com/cssnano/cssnano)).
423+
414424
Return `true` to keep the warning, or a falsy value (`false`/`null`/`undefined`) to suppress it.
415425

416426
> [!WARNING]
@@ -603,6 +613,7 @@ module.exports = {
603613
## Contributing
604614

605615
We welcome all contributions!
616+
606617
If you're new here, please take a moment to review our contributing guidelines.
607618

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

0 commit comments

Comments
 (0)