Skip to content

docs: improving typos in ISSUE_TEMPLATE files #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions .github/ISSUE_TEMPLATE/BUG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,31 @@ name: 🐛 Bug Report
about: Something went awry and you'd like to tell us about it.
---

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

### Bug report

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

### Actual Behavior

<!-- Explain exactly how it behave -->
<!-- Explain exactly how it behaves. -->

### Expected Behavior

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

### How Do We Reproduce?

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

### Please paste the results of `npx webpack-cli info` here, and mention other relevant information
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name: 📚 Documentation
about: Are the docs lacking or missing something? Do they need some new 🔥 hotness? Tell us here.
---

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

Documentation Is:
Documentation is:

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

- [ ] Missing
- [ ] Needed
Expand All @@ -17,9 +17,9 @@ Documentation Is:

### Please Explain in Detail...

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

### Your Proposal for Changes
12 changes: 7 additions & 5 deletions .github/ISSUE_TEMPLATE/FEATURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@ name: ✨ Feature Request
about: Suggest an idea for this project
---

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

### Feature Proposal

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

### Feature Use Case

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

### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.
17 changes: 11 additions & 6 deletions .github/ISSUE_TEMPLATE/MODIFICATION.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
---
name: 🔧 Modification Request
about: Would you like something work differently? Have an alternative approach? This is the template for you.
about: Want something to work differently? Have an alternative approach? This is the template for you.
---

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

### Modification Proposal

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

### Expected Behavior / Situation

<!-- Describe how you expect the feature or behavior to work. -->

### Actual Behavior / Situation

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

### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.
14 changes: 11 additions & 3 deletions .github/ISSUE_TEMPLATE/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
---
name: 🆘 Support, Help, and Advice
about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to https://github.com/webpack/webpack/discussions or StackOverflow.
about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to https://github.com/webpack/webpack/discussions or StackOverflow
---

Hey there! If you need support, help, or advice then this is not the place to ask.
Please visit [GitHub Discussions](https://github.com/webpack/webpack/discussions) or [StackOverflow](https://stackoverflow.com/questions/tagged/webpack) instead.
Hey there! 👋

If you need support, help, or advice then this is not the right place to ask.

Please visit one of the following instead:

- [GitHub Discussions](https://github.com/webpack/webpack/discussions)
- [StackOverflow](https://stackoverflow.com/questions/tagged/webpack)

Thanks for understanding!
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,13 @@ Finally, run Webpack using your preferred method.
Why? Because CSS support only these source map types.

The plugin respects the [`devtool`](https://webpack.js.org/configuration/devtool/) setting and uses the `SourceMapDevToolPlugin` internally.

Using a supported `devtool` value enables source map generation.

Enabling the `columns` option in `SourceMapDevToolPlugin` also allows source map generation.

Use source maps to map error message locations to their original modules (note that this may slow down compilation).

If you use your own `minify` function please refer to the `minify` section for correct handling of source maps.

## Options
Expand Down Expand Up @@ -179,6 +182,7 @@ module.exports = {
- Default: `true`

Use multi-process parallel running to improve the build speed.

The default number of concurrent runs: `os.cpus().length - 1` or `os.availableParallelism() - 1` (if this function is supported).

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

Overrides the default minify function.

By default, plugin uses [cssnano](https://github.com/cssnano/cssnano) package.
This is useful when using or testing unpublished versions or forks.

> This is useful when using or testing unpublished versions or forks.

Possible options:

Expand Down Expand Up @@ -271,6 +277,7 @@ module.exports = {
#### `Array`

If an array of functions is passed to the `minify` option, the `minimizerOptions` must also be an array.

The function index in the `minify` array corresponds to the options object with the same index in the `minimizerOptions` array.

**webpack.config.js**
Expand Down Expand Up @@ -337,6 +344,7 @@ module.exports = {
#### `Array`

The function index in the `minify` array corresponds to the options object with the same index in the `minimizerOptions` array.

If you use `minimizerOptions` like object, all `minify` function accept it.

> 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`.
Expand All @@ -362,6 +370,7 @@ module.exports = {
- Default: `{ from: assetName }`

Allows filtering options [`processoptions`](https://postcss.org/api/#processoptions) for the cssnano.

The `parser`,` stringifier` and `syntax` can be either a function or a string indicating the module that will be imported.

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

Filter css-minimizer warnings (By default [cssnano](https://github.com/cssnano/cssnano)).

Return `true` to keep the warning, or a falsy value (`false`/`null`/`undefined`) to suppress it.

> [!WARNING]
Expand Down Expand Up @@ -603,6 +613,7 @@ module.exports = {
## Contributing

We welcome all contributions!

If you're new here, please take a moment to review our contributing guidelines.

[CONTRIBUTING](./.github/CONTRIBUTING.md)
Expand Down