From 4b3ffde20856bd9da8386317490bb1a9fbf34b3a Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sun, 22 Aug 2021 17:06:41 -0700 Subject: [PATCH] docs: issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 20 ++++++++------ .github/ISSUE_TEMPLATE/lsp_bug_report.yml | 33 +++++++++++------------ 2 files changed, 27 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ba93cdd688..fa8d05f6b5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -6,11 +6,11 @@ body: - type: markdown attributes: value: | - _Before reporting:_ search [existing issues](https://github.com/neovim/neovim/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and check the [FAQ](https://github.com/neovim/neovim/wiki/FAQ). Read `:help vim-differences` first. + _Before reporting:_ search [existing issues](https://github.com/neovim/neovim/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and check the [FAQ](https://github.com/neovim/neovim/wiki/FAQ). Usage questions such as "How do I...?" belong on the [Neovim Discourse](https://neovim.discourse.group/c/7-category/7) and will be closed. - type: input attributes: - label: "Neovim version (`nvim -v`)" + label: "Neovim version (nvim -v)" placeholder: "0.6.0 commit db1b0ee3b30f" validations: required: true @@ -18,7 +18,7 @@ body: attributes: label: "Vim (not Nvim) behaves the same?" description: "Does `vim -u DEFAULTS` have the same issue? Note the exact Vim version (`8.x.yyyy`)." - placeholder: "No. Tested Vim 7.3.432" + placeholder: "no, vim 7.3.432" validations: required: true - type: input @@ -35,8 +35,8 @@ body: required: true - type: input attributes: - label: "`$TERM` environment variable" - placeholder: "`echo $TERM`" + label: "$TERM environment variable" + placeholder: "echo $TERM" validations: required: true @@ -52,9 +52,13 @@ body: attributes: label: "How to reproduce the issue" description: | - Steps to reproduce using `nvim -u NORC` or `nvim -u NONE` (try both). - For build failures: list the exact steps including CMake flags (if any). - For shell-related problems: try `env -i TERM=ansi-256color "$(which nvim)"`. + - Steps to reproduce using `nvim -u NORC` or `nvim -u NONE` (try both). + - For build failures: list the exact steps including CMake flags (if any). + - For shell-related problems: try `env -i TERM=ansi-256color "$(which nvim)"`. + placeholder: | + nvim -u NONE + :edit foo + yiwp validations: required: true diff --git a/.github/ISSUE_TEMPLATE/lsp_bug_report.yml b/.github/ISSUE_TEMPLATE/lsp_bug_report.yml index c8a4c433dd..b5b7687bf8 100644 --- a/.github/ISSUE_TEMPLATE/lsp_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/lsp_bug_report.yml @@ -1,5 +1,5 @@ -name: Language server (LSP) client bug report -description: Report an issue with Neovim builtin LSP +name: Language server (LSP) client bug +description: Report an issue with Neovim LSP labels: [bug, lsp] body: @@ -10,7 +10,7 @@ body: - type: input attributes: - label: "Neovim version (`nvim -v`)" + label: "Neovim version (nvim -v)" placeholder: "0.6.0 commit db1b0ee3b30f" validations: required: true @@ -23,23 +23,23 @@ body: - type: input attributes: label: "Operating system/version" + placeholder: "emacs 23" validations: required: true - type: textarea attributes: - label: `:checkhealth nvim lspconfig` + label: ':checkhealth' description: | Paste the results from `nvim -c ":checkhealth nvim lspconfig"` render: markdown - - type: markdown - attributes: - value: | - Note: if the issue is with an autocompletion or other LSP plugin, report it to that plugin's issue tracker. Download the minimal config with `curl -LO https://raw.githubusercontent.com/neovim/nvim-lspconfig/master/test/minimal_init.lua` and modify it to include any specific commands or servers pertaining to your issues. - type: textarea attributes: - label: "Steps to reproduce using `nvim -u minimal_init.lua`" + label: 'Steps to reproduce using "nvim -u minimal_init.lua"' + description: | + - Download the minimal config with `curl -LO https://raw.githubusercontent.com/neovim/nvim-lspconfig/master/test/minimal_init.lua` and modify it to include any specific commands or servers pertaining to your issues. + - _Note_: if the issue is with an autocompletion or other LSP plugin, report to that plugin's issue tracker. validations: required: true @@ -51,14 +51,11 @@ body: attributes: label: "Actual behavior" - - type: markdown - attributes: - value: | - Upload `lsp.log` before and after the problem in a [secret gist](https://gist.github.com/). Paste the url to the gist in the text field below. - - - You can set the log level by adding this after setting up LSP in your config: `vim.lsp.set_log_level("debug")` - - You can find the location of the log with `:lua print(vim.lsp.get_log_path())` - - type: input attributes: - label: "Uploaded log file" + label: "Log file" + placeholder: "https://gist.github.com/prakhar1989/1b0a2c9849b2e1e912fb" + description: | + - Upload `lsp.log` before and after the problem in a [secret gist](https://gist.github.com/). Paste the URL to the gist. + - You can set the log level by adding `vim.lsp.set_log_level("debug")` after setting up LSP in your config. + - You can find the location of the log with `:lua print(vim.lsp.get_log_path())`