Merge branch 'master' into variables-coerce-type

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,35 +7,50 @@ assignees: ''
 
 ---
 
-**Describe the bug**
+> DO NOT DELETE THIS TEMPLATE. IF YOU DELETE THIS TEMPLATE AND DO NOT COMPLETE IT, YOUR ISSUE WILL BE CLOSED.
-A clear and concise description of what the bug is.
 
-**To Reproduce**
+### Describe the bug
-List of steps to reproduce
 
-Vimspector config file:
+> Provide A clear and concise description of what the bug is.
+
+### Minimal reproduciton
+
+> Please answer the following questions
+
+* Does your issue reproduce using `vim -Nu /path/to/vimspector/support/minimal_vimrc` ? \[Yes/No]
+* If you are using Neovim, does your issue reproduce using Vim? \[Yes/No]
+
+> List of steps to reproduce:
+
+> 1. Run `vim -Nu /path/to/vimspector/support/minimal_vimrc`
+> 2. Open _this project_...
+> 3. Press _this sequence of keys_
+
+> Use the following Vimspector config file:
 
 ```
 paste .vimspector.json here
 ```
 
-**Expected behavior**
+### Expected behaviour
-A clear and concise description of what you expected to happen.
 
-**Actual behaviour**
+> Provide A clear and concise description of what you expected to happen.
-What actually happened, including output, log files etc.
 
-Please include:
+### Actual behaviour
-* Vimspector log (~/.vimspector.log)
-* Output from any or all UI diagnostic tabs (Server, etc.)
 
-**Environemnt**
+> What actually happened, including output, log files etc.
 
-NOTE: NeoVim is supported only on a best-effort basis. Please check the README
+> Please include:
+> * Vimspector log (~/.vimspector.log)
+> * Output from any or all UI diagnostic tabs (Server, etc.)
+
+### Environemnt
+
+***NOTE***: NeoVim is supported only on a best-effort basis. Please check the README
 for limitations of neovim. Don't be offended if I ask you to reproduce issues in
 Vim.
 
-NOTE: Windows support is experimental and best-efrort only. If you find an
+***NOTE***: Windows support is experimental and best-efrort only. If you find an
 issue related to Windows or windows-isms, consider sending a PR or
 discussing on Gitter rather than raising an issue.
 
@@ -80,6 +95,14 @@ paste here
 ```
 
 * Operating system: <linux or macOS> and version
+  
+### Declaration
+
+> Please complete the following declaration. If this declaration is not completed, your issue may be closed without comment.
+
+* I have read and understood [CONTRIBUTING.md](https://github.com/puremourning/vimspector/blob/master/CONTRIBUTING.md) \[Yes/No]
+
+
+### Additional information
 
-**Additional context**
 Add any other context about the problem here.

CONTRIBUTING.md

@@ -45,6 +45,7 @@ of the following reasons:
 * The [issue template][issue-template] was not completed
 * The issue or comment is off-topic
 * The issue does not represent a Vimspector bug or feature request
+* The issue cannot be reasonably reproduced using the minimal vimrc
 * etc.
 
 Issue titles are important. It's not usually helpful to write a title like
@@ -60,6 +61,24 @@ diagnostics without having to spend time asking for them, and waiting for the
 response. This means *you get a better answer, faster*. So it's worth it,
 honestly.
 
+### Reproduce your issue with the minimal vimrc
+
+Many problems can be caused by unexpected configuration or other plugins. 
+Therefore when raising an issue, you must attempt to reproduce your issue
+with the minimal vimrc provided, and to provide any additional changes required
+to that file in order to reproduce it. The purpose of this is to ensure that
+the issue is not a conflict with another plugin, or a problem unique to your
+configuration.
+
+If your issue does _not_ reproduce with the minimal vimrc, then you must say so
+in the issue report.
+
+The minimal vimrc is in `support/test/minimal_vimrc` and can be used as follows:
+
+```
+vim -Nu /path/to/vimspector/support/minimal_vimrc
+```
+
 ## Pull Requests
 
 When contributing pull requests, I ask that: