aboutsummaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorChristian Clason <christian.clason@uni-due.de>2021-09-12 18:54:15 +0200
committerGitHub <noreply@github.com>2021-09-12 09:54:15 -0700
commit86d5f2a8b9516c90e3a6e9d3aca3e5e772814a34 (patch)
treef859d92d026b03cd2147d52ecbf5a284c9d01430 /.github/ISSUE_TEMPLATE
parentfeat(csharp_ls): add support for C# using csharp-ls language server (#1251) (diff)
downloadnvim-lspconfig-86d5f2a8b9516c90e3a6e9d3aca3e5e772814a34.tar
nvim-lspconfig-86d5f2a8b9516c90e3a6e9d3aca3e5e772814a34.tar.gz
nvim-lspconfig-86d5f2a8b9516c90e3a6e9d3aca3e5e772814a34.tar.bz2
nvim-lspconfig-86d5f2a8b9516c90e3a6e9d3aca3e5e772814a34.tar.lz
nvim-lspconfig-86d5f2a8b9516c90e3a6e9d3aca3e5e772814a34.tar.xz
nvim-lspconfig-86d5f2a8b9516c90e3a6e9d3aca3e5e772814a34.tar.zst
nvim-lspconfig-86d5f2a8b9516c90e3a6e9d3aca3e5e772814a34.zip
chore: improve issue templates (#1253)
* chore: disable blank issue template, add Discourse link * chore: turn issue template into form
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md48
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml83
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml6
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md13
4 files changed, 102 insertions, 48 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 68b48a19..00000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,48 +0,0 @@
----
-name: Bug report
-about: Report a problem in nvim-lspconfig
-title: ''
-labels: bug
-
----
-
-<!-- Before reporting: search existing issues and ensure you are running the latest nightly of neovim and the latest version of nvim-lspconfig. Note that this repository implements configuration and initialization of language servers. Implementation of the language server spec itself is located in the neovim core repository-->
-
-- `nvim --version`:
-- nvim-lspconfig version(commit hash):
-- What language server (If the problem is related to a specific language server):
-- Can you reproduce this behavior on other language server clients (vscode, languageclient-neovim, coc.nvim, etc.):
-- Can you reproduce this behavior on other language servers offered in the nvim-lspconfig repo? (pyls -> pyright):
-- Is the problem isolated to a particular language server:
-- Operating system/version:
-
-### How to reproduce the problem from neovim startup
-
-### Actual behaviour
-
-### Expected behaviour
-
-### Minimal init.vim or init.lua and code sample
-<!-- You can download a minimal_init.lua from here
- curl -fLO https://raw.githubusercontent.com/neovim/nvim-lspconfig/master/test/minimal_init.lua
- After editing to include your language server, run neovim with nvim -u minimal_init.lua -->
-
-### Health check
-<details>
-<summary>Checkhealth result</summary>
-
-```
-Run `:checkhealth lspconfig` and paste the result here
-```
-</details>
-
-### LSP log
-<!-- If not using the minimal_init.lua please add vim.lsp.set_log_level("debug") to your lua block
- in init.vim and paste a link to your log file, located at $HOME/.cache/nvim/lsp.log (formerly $HOME/.local/share/nvim/lsp.log) -->
-<details>
-<summary>Log file</summary>
-
-```
-paste your log here
-```
-</details>
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 00000000..ae2f76f8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,83 @@
+name: Bug report
+description: Report a problem in nvim-lspconfig
+labels: [bug]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Before reporting: search existing issues and ensure you are running the latest nightly of neovim and the latest version of nvim-lspconfig. Note that this repository implements configuration and initialization of language servers. Implementation of the language server spec itself is located in the neovim core repository.
+ - type: textarea
+ attributes:
+ label: "Description"
+ description: "A short description of the problem you are reporting."
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: "Neovim version"
+ description: "Output of `nvim --version`"
+ placeholder: |
+ NVIM v0.6.0-dev+209-g0603eba6e
+ Build type: Release
+ LuaJIT 2.1.0-beta3
+ validations:
+ required: true
+ - type: input
+ attributes:
+ label: "Nvim-lspconfig version"
+ description: "Commit hash"
+ placeholder: 1344a859864d4e6d23d3f3adf56d49e6386ec0d2
+ - type: input
+ attributes:
+ label: "Operating system and version"
+ placeholder: "macOS 11.5"
+ validations:
+ required: true
+ - type: input
+ attributes:
+ label: "Affected language servers"
+ description: "If this issue is specific to one or more language servers, list them here. If not, write 'all'."
+ placeholder: "clangd"
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: "Steps to reproduce"
+ description: "Steps to reproduce using the minimal config provided below."
+ placeholder: |
+ 1. `nvim -nu minimal.lua`
+ 2. ...
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: "Actual behavior"
+ description: "Observed behavior."
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: "Expected behavior"
+ description: "A description of the behavior you expected."
+ - type: textarea
+ attributes:
+ label: "Minimal config"
+ render: Lua
+ description: "You can download a `minimal_init.lua via `curl -fLO https://raw.githubusercontent.com/neovim/nvim-lspconfig/master/test/minimal_init.lua`. Then edit it to include your language server and add necessary configuration and paste it here."
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: "Health check"
+ description: "Run `:checkhealth lspconfig` and paste the results here."
+ validations:
+ required: true
+ - type: input
+ attributes:
+ label: "LSP log"
+ description: "If not using the `minimal_init.lua`, add `vim.lsp.set_log_level('debug')` to your LSP setup, upload the log file at `$HOME/.cache/nvim/lsp.log` to https://gist.github.com, and paste the link here."
+ validations:
+ required: true
+
+
+
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..442c88e1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,6 @@
+blank_issues_enabled: false
+contact_links:
+ - name: Question
+ url: https://neovim.discourse.group
+ about: Usage questions and support requests are answered in the Neovim Discourse
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..875a2533
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,13 @@
+---
+name: Feature request
+about: Request a feature in nvim-lspconfig
+title: ''
+labels: feature-request
+
+---
+
+<!-- Before reporting: search existing issues. Implementation of the language server spec itself is located in the neovim core repository and feature requests may be better suited for core. -->
+
+### Requested feature
+
+### Motivation