#137: Update the github issue template

lando · Jul 29, 2017 · 64098e9 · 64098e9
1 parent 2fb08cf
commit 64098e9
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 14 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,9 +1,10 @@
-Please complete the following steps. **The more steps you complete the more
-likely we are to address your issue!**
+Please complete the following steps.
 
-1. Please review the [current list of issues](https://github.com/kalabox/lando/issues) to make sure you are not submitting a duplicate.
-2. Please tag your issue appropriately. Please review the [tagging criteria](https://github.com/kalabox/lando/blob/HEAD/CONTRIBUTING.md).
-3. Based on the issue type tag selected above please fill in the relevant section below.
+**The more steps you complete the more likely we are to address your issue!**
+
+1.  Please review the [current list of issues](https://github.com/kalabox/lando/issues) to make sure you are not submitting a duplicate.
+2.  Please tag your issue appropriately. Please review the [tagging criteria](https://docs.lndo.io/dev/contributing.html).
+3.  Based on the issue type tag selected above please fill in the relevant section below.
 
 Bug Report
 ==========
@@ -14,24 +15,65 @@ What is your lando version and operating system?
 
 *Example: v3.0.0-alpha1 on Windows 10 Professional*
 
-Have you previously installed lando? If so, what version?
+**Tell us about your `.lando.yml`**
+
+Paste in the contents of your `.lando.yml` this is **SUPER HELPFUL** for us.
+
+*Example:*
+
+```yml
+name: lamp2
+recipe: lamp
+config:
+  php: '5.6'
+  webroot: www
+  database: mysql
+  xdebug: true
+  conf:
+    server: config/lamp.conf
+    database: config/mysql
+    php: config/php.ini
+```
+
+It is also helpful to include other relevant config files. For example, include `pantheon.yml` for a `pantheon` recipe if applicable. Include `php.ini` or `mysql.cnf` if you are overriding our defualt config.
+
+**Tell us about the command you were running**
+
+Paste in a series of commands that caused the bug.
+
+*Example:*
+
+```bash
+lando init mysite --recipe lamp --webroot web
+lando start
+# Edited my lando.yml as above
+lando rebuild -y
+```
+
+**Tell us about the error you got**
+
+Rerun the command that produced your error in `verbose` mode. Paste in the error and the ~100 lines that proceeded it.
 
-*Example: Yes, I've installed lando v3.0.0-alpha4*
+*Example:*
 
-**Tell us about your bug**
+```bash
+lando CMDTHATFAILED -- -vvvv
+```
 
-Give a brief description of what happened, including any error messages that appeared.
+**Tell us generally about your bug**
 
 *Example: I tried to create a pantheon site but got a `LowerCase` not defined exception*
 
 Please detail the steps we can take to replicate this bug. Be as detailed as possible.
 
-> Example:
+*Example:*
 
-> 1. Started up GUI
-> 2. Clicked on my Pantheon account in the sidebar
-> 3. Selected a site and an environment
-> 4. Kept the default create options and pressed submit
+```bash
+1. Started up GUI
+2. Clicked on my Pantheon account in the sidebar
+3. Selected a site and an environment
+4. Kept the default create options and pressed submit
+```
 
 **Tell us more**
 

diff --git a/docs/changelog/2017.md b/docs/changelog/2017.md
@@ -1,3 +1,8 @@
+v3.0.0-alpha.20 - [July 30, 2017](https://github.com/kalabox/lando/releases/tag/v3.0.0-alpha.20)
+-------------------------------
+
+*   Updated `GitHub` issue template. [#137](https://github.com/kalabox/lando/issues/137)
+
 v3.0.0-alpha.19 - [July 29, 2017](https://github.com/kalabox/lando/releases/tag/v3.0.0-alpha.19)
 -------------------------------