chore(github): add issue_template.md (#677)

2017-05-29 14:47:40 +01:00 · 2017-05-29 14:47:40 +01:00 · efd1f7886a
parent d77b399f34
commit efd1f7886a
1 changed files with 79 additions and 0 deletions
--- a/.github/issue_template.md
+++ b/.github/issue_template.md
@ -0,0 +1,79 @@
+<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->
+
+## Prerequisites
+
+- We realize there is a lot of data requested here. We ask only that you do your best to provide as much information as possible so we can better help you.
+- Support questions are better asked in one of the following locations:
+	- [Stack Overflow](http://stackoverflow.com/questions/tagged/html-webpack-plugin)
+- Ensure the issue isn't already reported.
+- Should be reproducible with the latest version of `html-webpack-plugin`.
+	- (Ensure `npm ls html-webpack-plugin` matches ![](https://img.shields.io/npm/v/html-webpack-plugin.svg))
+
+*Delete the above section and the instructions in the sections below before submitting*
+
+
+## Description
+
+If this is a feature request, explain why it should be added. Specific use-cases are best.
+
+For bug reports, please provide as much *relevant* info as possible.
+
+### Error Message & Stack Trace
+
+```
+COPY THE ERROR MESSAGE, INCLUDING STACK TRACE HERE
+```
+
+### Config
+
+Copy the relevant section from `webpack.config.js`:
+
+```js
+module.exports = {
+  entry: 'app.js',
+  output: {
+    path: 'dist',
+    filename: 'index_bundle.js'
+  },
+  module: {
+    rules: [
+      ...
+    ]
+  }
+  plugins: [
+    new HtmlWebpackPlugin(),
+    ...
+  ]
+}
+```
+
+Copy your template file:
+
+```html
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>My App</title>
+    </head>
+    <body>
+    </body>
+</html>
+```
+
+
+## Relevant Links
+
+- If your project is public, link to the repo so we can investigate directly.
+- **BONUS POINTS:** Create a [minimal reproduction](http://stackoverflow.com/help/mcve) and upload it to GitHub. This will get you the fastest support.
+
+
+## Environment
+
+Tell us which operating system you are using, as well as which versions of Node.js, npm, webpack, and html-webpack-plugin. Run the following to get it quickly:
+
+```
+node -e "var os=require('os');console.log('Node.js ' + process.version + '\n' + os.platform() + ' ' + os.release())"
+npm --version
+npm ls webpack
+npm ls html-webpack-plugin
+```