jyapayne/vimspector
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update bug_report.md

Browse source
This commit is contained in:
Ben Jackson 2020-08-02 18:25:06 +01:00 • committed by GitHub
commit 7824bb29b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

55
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -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 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 for limitations of neovim. Don't be offended if I ask you to reproduce issues in
Vim. 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 issue related to Windows or windows-isms, consider sending a PR or
discussing on Gitter rather than raising an issue. discussing on Gitter rather than raising an issue.
@ -81,5 +96,13 @@ paste here
* Operating system: <linux or macOS> and version * Operating system: <linux or macOS> and version
**Additional context** ### 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
Add any other context about the problem here. Add any other context about the problem here.