Skip to content

Commit af6652f

Browse files
authored
docs: improving typos in ISSUE_TEMPLATE files (webpack-contrib#1636)
1 parent a483f21 commit af6652f

File tree

6 files changed

+78
-39
lines changed

6 files changed

+78
-39
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.
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: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ module.exports = {
6565
};
6666
```
6767

68-
Run `webpack` using your preferred method.
68+
Finally, run `webpack` using the method you normally use (e.g., via CLI or an npm script).
6969

7070
If you need to extract CSS into a separate file (i.e. do not store CSS in a JS module), consider using the [recommend example](https://github.com/webpack-contrib/css-loader#recommend).
7171

@@ -143,7 +143,9 @@ module.exports = {
143143

144144
#### `object`
145145

146-
Allows filtering of `url()` values. Any filtered `url()` will not be resolved (left in the code as they were written).
146+
Allows filtering of `url()` values.
147+
148+
Any filtered `url()` will not be resolved (left in the code as they were written).
147149

148150
**webpack.config.js**
149151

@@ -202,7 +204,9 @@ type importFn =
202204
Default: `true`
203205

204206
Allows you to enable or disable handling of `@import` at-rules.
207+
205208
Controls how `@import` statements are resolved.
209+
206210
Absolute URLs in `@import` will be moved in runtime code.
207211

208212
Examples resolutions:
@@ -259,7 +263,9 @@ type filter = (url: string, media: string, resourcePath: string) => boolean;
259263

260264
Default: `undefined`
261265

262-
Allows filtering of `@import`. Any filtered `@import` will not be resolved (left in the code as they were written).
266+
Allows filtering of `@import`.
267+
268+
Any filtered `@import` will not be resolved (left in the code as they were written).
263269

264270
**webpack.config.js**
265271

@@ -928,6 +934,7 @@ type localIdentHashSalt = string;
928934
Default: `undefined`
929935

930936
Allows to add custom hash to generate more unique classes.
937+
931938
For more information see [output.hashSalt](https://webpack.js.org/configuration/output/#outputhashsalt).
932939

933940
**webpack.config.js**
@@ -961,6 +968,7 @@ type localIdentHashFunction = string;
961968
Default: `md4`
962969

963970
Allows to specify hash function to generate classes .
971+
964972
For more information see [output.hashFunction](https://webpack.js.org/configuration/output/#outputhashfunction).
965973

966974
**webpack.config.js**
@@ -994,6 +1002,7 @@ type localIdentHashDigest = string;
9941002
Default: `hex`
9951003

9961004
Allows to specify hash digest to generate classes.
1005+
9971006
For more information see [output.hashDigest](https://webpack.js.org/configuration/output/#outputhashdigest).
9981007

9991008
**webpack.config.js**
@@ -1027,6 +1036,7 @@ type localIdentHashDigestLength = number;
10271036
Default: `20`
10281037

10291038
Allows to specify hash digest length to generate classes.
1039+
10301040
For more information, see [output.hashDigestLength](https://webpack.js.org/configuration/output/#outputhashdigestlength).
10311041

10321042
**webpack.config.js**
@@ -1124,7 +1134,9 @@ type getLocalIdent = (
11241134
Default: `undefined`
11251135

11261136
Allows to specify a function to generate the classname.
1137+
11271138
By default we use built-in function to generate a classname.
1139+
11281140
If your custom function returns `null` or `undefined`, the built-in generator is used as a `fallback`.
11291141

11301142
**webpack.config.js**
@@ -1218,6 +1230,7 @@ module.exports = {
12181230
```
12191231

12201232
To set a custom name for namedExport, can use [`exportLocalsConvention`](#exportLocalsConvention) option as a function.
1233+
12211234
See below in the [`examples`](#examples) section.
12221235

12231236
##### `exportGlobals`
@@ -1388,7 +1401,9 @@ Default: `false`
13881401
Export only locals.
13891402

13901403
**Useful** when you use **css modules** for pre-rendering (for example SSR).
1404+
13911405
For pre-rendering with `mini-css-extract-plugin` you should use this option instead of `style-loader!css-loader` **in the pre-rendering bundle**.
1406+
13921407
It doesn't embed CSS; it only exports the identifier mappings.
13931408

13941409
**webpack.config.js**
@@ -1431,7 +1446,9 @@ type getJSON = ({
14311446

14321447
Default: `undefined`
14331448

1434-
Enables a callback to output the CSS modules mapping JSON. The callback is invoked with an object containing the following:
1449+
Enables a callback to output the CSS modules mapping JSON.
1450+
1451+
The callback is invoked with an object containing the following:
14351452

14361453
- `resourcePath`: the absolute path of the original resource, e.g., `/foo/bar/baz.module.css`
14371454

@@ -1473,6 +1490,7 @@ Enables a callback to output the CSS modules mapping JSON. The callback is invok
14731490
```
14741491

14751492
Using `getJSON`, it's possible to output a file with all CSS module mappings.
1493+
14761494
In the following example, we use `getJSON` to cache canonical mappings and add stand-ins for any composed values (through `composes`), and we use a custom plugin to consolidate the values and output them to a file:
14771495

14781496
**webpack.config.js**
@@ -1740,6 +1758,7 @@ type esModule = boolean;
17401758
Default: `true`
17411759

17421760
By default, `css-loader` generates JS modules that use the ES modules syntax.
1761+
17431762
There are some cases in which using ES modules is beneficial, like in the case of [module concatenation](https://webpack.js.org/plugins/module-concatenation-plugin/) and [tree shaking](https://webpack.js.org/guides/tree-shaking/).
17441763

17451764
You can enable CommonJS module syntax using:
@@ -1773,6 +1792,7 @@ type exportType = "array" | "string" | "css-style-sheet";
17731792
Default: `'array'`
17741793

17751794
Allows exporting styles as array with modules, string or [constructable stylesheet](https://developers.google.com/web/updates/2019/02/constructable-stylesheets) (i.e. [`CSSStyleSheet`](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet)).
1795+
17761796
The default value is `'array'`, i.e. loader exports an array of modules with a specific API which is used in `style-loader` or other.
17771797

17781798
**webpack.config.js**
@@ -1983,7 +2003,9 @@ module.exports = {
19832003
### Recommend
19842004

19852005
For `production` builds, it's recommended to extract the CSS from your bundle being able to use parallel loading of CSS/JS resources later on.
2006+
19862007
This can be achieved by using the [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin), because it creates separate css files.
2008+
19872009
For `development` mode (including `webpack-dev-server`) you can use [style-loader](https://github.com/webpack-contrib/style-loader), because it injects CSS into the DOM using multiple `<style></style>` and works faster.
19882010

19892011
> [!NOTE]
@@ -2212,6 +2234,7 @@ module.exports = {
22122234
### Separating `Interoperable CSS`-only and `CSS Module` features
22132235

22142236
The following setup is an example of allowing `Interoperable CSS` features only (such as `:import` and `:export`) without using further `CSS Module` functionality by setting the `mode` option for all files that do not match the `*.module.scss` naming convention. This is for reference, as having `ICSS` features applied to all files was default `css-loader` behavior before v4.
2237+
22152238
Meanwhile, all files matching `*.module.scss` are treated as `CSS Modules` in this example.
22162239

22172240
An example case is assumed where a project requires canvas drawing variables to be synchronized with CSS - canvas drawing uses the same color (set by color name in JavaScript) as HTML background (set by class name in CSS).
@@ -2317,7 +2340,9 @@ ctx.fillStyle = `${svars.colorBackgroundCanvas}`;
23172340

23182341
## Contributing
23192342

2320-
Please take a moment to read our contributing guidelines if you haven't yet done so.
2343+
We welcome all contributions!
2344+
2345+
If you are new here, please take a moment to review our contributing guidelines before submitting issues or pull requests.
23212346

23222347
[CONTRIBUTING](./.github/CONTRIBUTING.md)
23232348

0 commit comments

Comments
 (0)