From 7824bb29b2a1047c923171277529d467a2c86313 Mon Sep 17 00:00:00 2001 From: Ben Jackson Date: Sun, 2 Aug 2020 18:25:06 +0100 Subject: [PATCH] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 55 ++++++++++++++++++++-------- 1 file changed, 39 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 887fbb1..1788c04 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,35 +7,50 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +> DO NOT DELETE THIS TEMPLATE. IF YOU DELETE THIS TEMPLATE AND DO NOT COMPLETE IT, YOUR ISSUE WILL BE CLOSED. -**To Reproduce** -List of steps to reproduce +### Describe the bug -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** -A clear and concise description of what you expected to happen. +### Expected behaviour -**Actual behaviour** -What actually happened, including output, log files etc. +> Provide A clear and concise description of what you expected to happen. -Please include: -* Vimspector log (~/.vimspector.log) -* Output from any or all UI diagnostic tabs (Server, etc.) +### Actual behaviour -**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: 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.