Skip to content

Commit d29f662

Browse files
committed
Make issue template easier to understand [skip ci]
With the current issue template, people often won't know what to remove exactly. With the new template, users only have to fill in the questions and optionally can remove the hints. Since the hints are HTML comments, they won't appear in the issue. Inspired by Yarn's great issue template: https://raw.githubusercontent.com/yarnpkg/yarn/master/.github/ISSUE_TEMPLATE.md
1 parent 027c5a8 commit d29f662

File tree

2 files changed

+13
-46
lines changed

2 files changed

+13
-46
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 9 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,15 @@
1-
## **BEFORE YOU SUBMIT** please read the following:
2-
If you have a support request or question please
3-
submit them to [StackOverflow](http://stackoverflow.com/questions/tagged/webpack) using the tag `[webpack]` or the [webpack Gitter](https://gitter.im/webpack/webpack). Future support requests will be closed.
4-
(remove this from issue)
1+
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
52

3+
**Do you want to request a *feature* or report a *bug*?**
4+
<!-- Please ask questions on StackOverflow or the webpack Gitter (https://gitter.im/webpack/webpack). Questions will be closed. -->
65

6+
**What is the current behavior?**
77

8-
**I'm submitting a bug report**
9-
**I'm submitting a feature request**
10-
**I'm submitting a support request** => Please do not submit support request here, see note at the top of this template.
11-
(remove inappropriate sentences)
8+
**If the current behavior is a bug, please provide the steps to reproduce.**
9+
<!-- A great way to do this is to provide your configuration via a GitHub gist. -->
1210

11+
**What is the expected behavior?**
1312

14-
**Webpack version:**
15-
1.10.x/2.x
13+
**If this is a feature request, what is motivation or use case for changing the behavior?**
1614

17-
18-
**Please tell us about your environment:**
19-
OSX 10.x / Linux / Windows 10
20-
21-
22-
**Current behavior:**
23-
24-
25-
**Expected/desired behavior:**
26-
27-
28-
* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem along with a gist/jsbin of your webpack configuration.**
29-
30-
31-
* **What is the expected behavior?**
32-
33-
34-
* **What is the motivation / use case for changing the behavior?**
35-
36-
37-
* **Browser:** [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
38-
39-
* **Language:** [all | TypeScript X.X | ES6/7 | ES5 | Dart | ...]
15+
**Please mention other relevant information, such as the browser version, Node.js version or programming language.**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- [ ] Docs have been added / updated (for bug fixes / features)
44

55

6-
**What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
6+
**What kind of change does this PR introduce?**
77
- [ ] Bugfix
88
- [ ] Feature
99
- [ ] Code style update (formatting, local variables)
@@ -12,24 +12,15 @@
1212
- [ ] CI related changes
1313
- [ ] Other... Please describe:
1414

15-
**What is the current behavior?** (You can also link to an open issue here)
16-
17-
15+
**What is the current behavior?**
16+
<!-- Please write a summary here and - preferably - link to an open issue for more information. -->
1817

1918
**What is the new behavior?**
2019

21-
22-
2320
**Does this PR introduce a breaking change?**
2421
- [ ] Yes
2522
- [ ] No
2623

27-
If this PR contains a breaking change, please describe the following...
28-
29-
* Impact:
30-
* Migration path for existing applications:
31-
* Github Issue(s) this is regarding:
32-
24+
<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->
3325

3426
**Other information**:
35-

0 commit comments

Comments
 (0)