Skip to content

Commit da4e7b1

Browse files
snitin315snitin315
authored
docs: update bug report template (#159)
1 parent 9d84091 commit da4e7b1

File tree

5 files changed

+48
-77
lines changed

5 files changed

+48
-77
lines changed

‎.github/ISSUE_TEMPLATE/BUG.md

+19-34
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,33 @@ name: 🐛 Bug Report
33
about: Something went awry and you'd like to tell us about it.
44
---
55

6-
<!--
7-
Issues are so 🔥
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. -->
88

9-
If you remove or skip this template, you'll make the 🐼 sad and the mighty god
10-
of Github will appear and pile-drive the close button from a great height
11-
while making animal noises.
9+
### Bug report
1210

13-
👉🏽 Need support, advice, or help? Don't open an issue!
14-
Head to StackOverflow or https://gitter.im/webpack/webpack.
15-
-->
16-
17-
- Operating System:
18-
- Node Version:
19-
- NPM Version:
20-
- webpack Version:
21-
- source-map-loader Version:
22-
23-
### Expected Behavior
24-
25-
<!-- Remove this section if not reporting a bug or modification request. -->
11+
<!-- Please ask questions on discussions, StackOverflow or the webpack Gitter. -->
12+
<!-- https://github.com/webpack/webpack/discussions -->
13+
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
14+
<!-- https://gitter.im/webpack/webpack -->
15+
<!-- Issues which contain questions or support requests will be closed. -->
2616

2717
### Actual Behavior
2818

29-
<!-- Remove this section if not reporting a bug or modification request. -->
30-
31-
### Code
19+
<!-- Explain exactly how it behave -->
3220

33-
```js
34-
// webpack.config.js
35-
// If your code blocks are over 20 lines, please paste a link to a gist
36-
// (https://gist.github.com).
37-
```
21+
### Expected Behavior
3822

39-
```js
40-
// additional code, HEY YO remove this block if you don't need it
41-
```
23+
<!-- "It should work" is not a helpful explanation -->
24+
<!-- Explain exactly how it should behave -->
4225

4326
### How Do We Reproduce?
4427

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

48-
If your webpack config is over 50 lines long, please provide a URL to a repo
49-
for your beefy 🍖 app that we can use to reproduce.
50-
-->
35+
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information

‎.github/ISSUE_TEMPLATE/DOCS.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,8 @@ name: 📚 Documentation
33
about: Are the docs lacking or missing something? Do they need some new 🔥 hotness? Tell us here.
44
---
55

6-
<!--
7-
Issues are so 🔥
8-
9-
If you remove or skip this template, you'll make the 🐼 sad and the mighty god
10-
of Github will appear and pile-drive the close button from a great height
11-
while making animal noises.
12-
13-
👉🏽 Need support, advice, or help? Don't open an issue!
14-
Head to StackOverflow or https://gitter.im/webpack/webpack.
15-
-->
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. -->
168

179
Documentation Is:
1810

@@ -25,4 +17,10 @@ Documentation Is:
2517

2618
### Please Explain in Detail...
2719

20+
<!-- Please don't delete this template otherwise your issue will be closed immediately -->
21+
<!-- https://github.com/webpack/webpack/discussions -->
22+
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
23+
<!-- https://gitter.im/webpack/webpack -->
24+
<!-- Issues which contain questions or support requests will be closed. -->
25+
2826
### Your Proposal for Changes

‎.github/ISSUE_TEMPLATE/FEATURE.md

+10-16
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,17 @@ name: ✨ Feature Request
33
about: Suggest an idea for this project
44
---
55

6-
<!--
7-
Issues are so 🔥
8-
9-
If you remove or skip this template, you'll make the 🐼 sad and the mighty god
10-
of Github will appear and pile-drive the close button from a great height
11-
while making animal noises.
12-
13-
👉🏽 Need support, advice, or help? Don't open an issue!
14-
Head to StackOverflow or https://gitter.im/webpack/webpack.
15-
-->
16-
17-
- Operating System:
18-
- Node Version:
19-
- NPM Version:
20-
- webpack Version:
21-
- source-map-loader Version:
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. -->
228

239
### Feature Proposal
2410

11+
<!-- Please ask questions on discussions, StackOverflow or the webpack Gitter. -->
12+
<!-- https://github.com/webpack/webpack/discussions -->
13+
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
14+
<!-- https://gitter.im/webpack/webpack -->
15+
<!-- Issues which contain questions or support requests will be closed. -->
16+
2517
### Feature Use Case
18+
19+
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information

‎.github/ISSUE_TEMPLATE/MODIFICATION.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,19 @@ name: 🔧 Modification Request
33
about: Would you like something work differently? Have an alternative approach? This is the template for you.
44
---
55

6-
<!--
7-
Issues are so 🔥
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. -->
88

9-
If you remove or skip this template, you'll make the 🐼 sad and the mighty god
10-
of Github will appear and pile-drive the close button from a great height
11-
while making animal noises.
12-
13-
👉🏽 Need support, advice, or help? Don't open an issue!
14-
Head to StackOverflow or https://gitter.im/webpack/webpack.
15-
-->
9+
### Modification Proposal
1610

17-
- Operating System:
18-
- Node Version:
19-
- NPM Version:
20-
- webpack Version:
21-
- source-map-loader Version:
11+
<!-- Please ask questions on discussions, StackOverflow or the webpack Gitter. -->
12+
<!-- https://github.com/webpack/webpack/discussions -->
13+
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
14+
<!-- https://gitter.im/webpack/webpack -->
15+
<!-- Issues which contain questions or support requests will be closed. -->
2216

2317
### Expected Behavior / Situation
2418

2519
### Actual Behavior / Situation
2620

27-
### Modification Proposal
21+
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information

‎.github/ISSUE_TEMPLATE/SUPPORT.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: 🆘 Support, Help, and Advice
3-
about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to StackOverflow or https://gitter.im/webpack/webpack.
3+
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.
44
---
55

66
Hey there! If you need support, help, or advice then this is not the place to ask.
7-
Please visit [StackOverflow](https://stackoverflow.com/questions/tagged/webpack)
7+
Please visit [Discussions](https://github.com/webpack/webpack/discussions), [StackOverflow](https://stackoverflow.com/questions/tagged/webpack)
88
or [the Webpack Gitter](https://gitter.im/webpack/webpack) instead.

0 commit comments

Comments
 (0)