diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 42 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 2 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 3 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/lsp_bug_report.yml | 39 | ||||
| -rw-r--r-- | README.md | 2 |
5 files changed, 43 insertions, 45 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e9384c1982..ba93cdd688 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -6,62 +6,64 @@ 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). + _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. - type: input attributes: - label: "Neovim Version" - description: "`nvim --version`:" + label: "Neovim version (`nvim -v`)" + placeholder: "0.6.0 commit db1b0ee3b30f" validations: required: true - type: input attributes: - label: "Operating system/version:" + 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" validations: required: true - type: input attributes: - label: "Terminal name/version:" + label: "Operating system/version" + placeholder: "macOS 11.5" validations: required: true - type: input attributes: - label: "TERM environment variable" - description: "echo `$TERM`:" + label: "Terminal name/version" + placeholder: "xterm 3.1" + validations: + required: true + - type: input + attributes: + label: "`$TERM` environment variable" + placeholder: "`echo $TERM`" validations: required: true - type: input attributes: label: "Installation" - description: "How did you install neovim: build from repo / system package manager / appimage / homebrew / snap / chocolatey / other (please specify)?" + description: "How did you install neovim: build from repo / system package manager / appimage / homebrew / snap / chocolatey / other (describe)?" placeholder: "Arch User Repository (AUR)" validations: required: true - type: textarea attributes: - label: "Steps to reproduce" + label: "How to reproduce the issue" description: | - Steps to reproduce using `nvim -u NORC` and/or `nvim -u NONE` (please test both). - If you are reporting build failures, please list the exact sequence of steps including all CMake flags (if any). - validations: - required: true - - - type: input - attributes: - label: "Vim" - description: "Does Vim behave differently when called with `vim -u DEFAULTS`? (Please add the specific version, including patch level, of Vim that you tested.)" + 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)"`. validations: required: true - type: textarea attributes: label: "Expected behavior" - description: "A description of the behavior you expected. May optionally include logs, images, or videos." + description: "Describe the behavior you expect. May include logs, images, or videos." validations: required: true - - type: textarea attributes: label: "Actual behavior" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 35b9e23489..796707be03 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,4 +2,4 @@ blank_issues_enabled: true contact_links: - name: Question url: https://neovim.discourse.group/ - about: Please ask and answer questions about Neovim on Discourse. + about: Ask questions about configuration and usage of Neovim diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index a9ed2824cb..2b6fa3daf4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -11,7 +11,8 @@ body: - type: input attributes: label: "Feature already in Vim?" - description: "Does the feature already exist in Vim? If possible, please specify which version of Vim it was introduced in." + description: "Does the feature already exist in Vim? If possible, specify which version (or commit) that introduced it." + placeholder: "Yes, Vim 7.3.432" - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/lsp_bug_report.yml b/.github/ISSUE_TEMPLATE/lsp_bug_report.yml index ba1905329b..c8a4c433dd 100644 --- a/.github/ISSUE_TEMPLATE/lsp_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/lsp_bug_report.yml @@ -1,53 +1,52 @@ -name: Language server client bug report -description: Report a built-in lsp problem in Neovim +name: Language server (LSP) client bug report +description: Report an issue with Neovim builtin LSP labels: [bug, lsp] 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). Usage questions such as "How do I...?" or "Why isn't X language server/feature working?" belong on the [Neovim Discourse](https://neovim.discourse.group/c/7-category/7) and will be closed. + _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...?" or "Why isn't X language server/feature working?" belong on the [Neovim Discourse](https://neovim.discourse.group/c/7-category/7) and will be closed. - type: input attributes: - label: "Neovim Version" - description: "`nvim --version`:" + label: "Neovim version (`nvim -v`)" + placeholder: "0.6.0 commit db1b0ee3b30f" validations: required: true - type: input attributes: - label: "Language server name/version:" + label: "Language server name/version" + placeholder: "rls 0.5.2" validations: required: true - type: input attributes: - label: "Operating system/version:" + label: "Operating system/version" validations: required: true - type: textarea attributes: - label: Checkhealth + label: `:checkhealth nvim lspconfig` description: | - Paste the results from `nvim -c ":checkhealth nvim lspconfig"` here: + 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, please report it at that plugin's issue tracker. Download the minimal config with `wget 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 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" - description: | - Steps to reproduce using `nvim -u minimal_init.lua`: + label: "Steps to reproduce using `nvim -u minimal_init.lua`" validations: required: true - type: textarea attributes: label: "Expected behavior" - description: "A description of the behavior you expected. May optionally include logs, images, or videos." + description: "Describe the behavior you expect. May include logs, images, or videos." - type: textarea attributes: label: "Actual behavior" @@ -55,15 +54,11 @@ body: - type: markdown attributes: value: | - Please 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 the Lua command - `vim.lsp.set_log_level("debug")` - after setting up LSP in your config. + 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 find the location of the log with the command - `:lua print(vim.lsp.get_log_path())` + - 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: "Link to uploaded log file" + label: "Uploaded log file" @@ -1,7 +1,7 @@ [](https://neovim.io) [Documentation](https://neovim.io/doc/general/) | -[Chat](https://gitter.im/neovim/neovim) | +[Chat](https://app.element.io/#/room/#neovim:matrix.org) | [Twitter](https://twitter.com/Neovim) [](https://github.com/neovim/neovim/actions?query=workflow%3A%22CI%22) |