docs: update bug report template (#262)

webpack-contrib · Aug 30, 2021 · 5415029 · 5415029
1 parent 20de436
commit 5415029
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 77 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG.md b/.github/ISSUE_TEMPLATE/BUG.md
@@ -3,48 +3,33 @@ name: 🐛 Bug Report
 about: Something went awry and you'd like to tell us about it.
 ---
 
-<!--
-  Issues are so 🔥
+<!-- 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. -->
 
-  If you remove or skip this template, you'll make the 🐼 sad and the mighty god
-  of Github will appear and pile-drive the close button from a great height
-  while making animal noises.
+### Bug report
 
-  👉🏽 Need support, advice, or help? Don't open an issue!
-  Head to StackOverflow or https://gitter.im/webpack/webpack.
--->
-
-- Operating System:
-- Node Version:
-- NPM Version:
-- webpack Version:
-- compression-webpack-plugin Version:
-
-### Expected Behavior
-
-<!-- Remove this section if not reporting a bug or modification request. -->
+<!-- Please ask questions on discussions, StackOverflow or the webpack Gitter. -->
+<!-- https://github.com/webpack/webpack/discussions -->
+<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
+<!-- https://gitter.im/webpack/webpack -->
+<!-- Issues which contain questions or support requests will be closed. -->
 
 ### Actual Behavior
 
-<!-- Remove this section if not reporting a bug or modification request. -->
-
-### Code
+<!-- Explain exactly how it behave -->
 
-```js
-// webpack.config.js
-// If your code blocks are over 20 lines, please paste a link to a gist
-// (https://gist.github.com).
-```
+### Expected Behavior
 
-```js
-// additional code, HEY YO remove this block if you don't need it
-```
+<!-- "It should work" is not a helpful explanation -->
+<!-- Explain exactly how it should behave -->
 
 ### How Do We Reproduce?
 
-<!--
-  Remove this section if not reporting a bug.
+<!-- 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 -->
 
-  If your webpack config is over 50 lines long, please provide a URL to a repo
-  for your beefy 🍖 app that we can use to reproduce.
--->
+### Please paste the results of `npx webpack-cli info` here, and mention other relevant information
diff --git a/.github/ISSUE_TEMPLATE/DOCS.md b/.github/ISSUE_TEMPLATE/DOCS.md
@@ -3,16 +3,8 @@ name: 📚 Documentation
 about: Are the docs lacking or missing something? Do they need some new 🔥 hotness? Tell us here.
 ---
 
-<!--
-  Issues are so 🔥
-
-  If you remove or skip this template, you'll make the 🐼 sad and the mighty god
-  of Github will appear and pile-drive the close button from a great height
-  while making animal noises.
-
-  👉🏽 Need support, advice, or help? Don't open an issue!
-  Head to StackOverflow or https://gitter.im/webpack/webpack.
--->
+<!-- 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. -->
 
 Documentation Is:
 
@@ -25,4 +17,10 @@ Documentation Is:
 
 ### Please Explain in Detail...
 
+<!-- Please don't delete this template otherwise your issue will be closed immediately -->
+<!-- https://github.com/webpack/webpack/discussions -->
+<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
+<!-- https://gitter.im/webpack/webpack -->
+<!-- Issues which contain questions or support requests will be closed. -->
+
 ### Your Proposal for Changes
diff --git a/.github/ISSUE_TEMPLATE/FEATURE.md b/.github/ISSUE_TEMPLATE/FEATURE.md
@@ -3,23 +3,17 @@ name: ✨ Feature Request
 about: Suggest an idea for this project
 ---
 
-<!--
-  Issues are so 🔥
-
-  If you remove or skip this template, you'll make the 🐼 sad and the mighty god
-  of Github will appear and pile-drive the close button from a great height
-  while making animal noises.
-
-  👉🏽 Need support, advice, or help? Don't open an issue!
-  Head to StackOverflow or https://gitter.im/webpack/webpack.
--->
-
-- Operating System:
-- Node Version:
-- NPM Version:
-- webpack Version:
-- compression-webpack-plugin Version:
+<!-- 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. -->
 
 ### Feature Proposal
 
+<!-- Please ask questions on discussions, StackOverflow or the webpack Gitter. -->
+<!-- https://github.com/webpack/webpack/discussions -->
+<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
+<!-- https://gitter.im/webpack/webpack -->
+<!-- Issues which 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
diff --git a/.github/ISSUE_TEMPLATE/MODIFICATION.md b/.github/ISSUE_TEMPLATE/MODIFICATION.md
@@ -3,25 +3,19 @@ name: 🔧 Modification Request
 about: Would you like something work differently? Have an alternative approach? This is the template for you.
 ---
 
-<!--
-  Issues are so 🔥
+<!-- 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. -->
 
-  If you remove or skip this template, you'll make the 🐼 sad and the mighty god
-  of Github will appear and pile-drive the close button from a great height
-  while making animal noises.
-
-  👉🏽 Need support, advice, or help? Don't open an issue!
-  Head to StackOverflow or https://gitter.im/webpack/webpack.
--->
+### Modification Proposal
 
-- Operating System:
-- Node Version:
-- NPM Version:
-- webpack Version:
-- compression-webpack-plugin Version:
+<!-- Please ask questions on discussions, StackOverflow or the webpack Gitter. -->
+<!-- https://github.com/webpack/webpack/discussions -->
+<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
+<!-- https://gitter.im/webpack/webpack -->
+<!-- Issues which contain questions or support requests will be closed. -->
 
 ### Expected Behavior / Situation
 
 ### Actual Behavior / Situation
 
-### Modification Proposal
+### Please paste the results of `npx webpack-cli info` here, and mention other relevant information
diff --git a/.github/ISSUE_TEMPLATE/SUPPORT.md b/.github/ISSUE_TEMPLATE/SUPPORT.md
@@ -1,8 +1,8 @@
 ---
 name: 🆘 Support, Help, and Advice
-about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to StackOverflow or https://gitter.im/webpack/webpack.
+about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to https://github.com/webpack/webpack/discussions, StackOverflow or https://gitter.im/webpack/webpack.
 ---
 
 Hey there! If you need support, help, or advice then this is not the place to ask.
-Please visit [StackOverflow](https://stackoverflow.com/questions/tagged/webpack)
+Please visit [Discussions](https://github.com/webpack/webpack/discussions), [StackOverflow](https://stackoverflow.com/questions/tagged/webpack)
 or [the Webpack Gitter](https://gitter.im/webpack/webpack) instead.