diff options
Diffstat (limited to '.github/ISSUE_TEMPLATE')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 53 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 13 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/lsp_bug_report.yml | 34 |
3 files changed, 67 insertions, 33 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 11f27dde21..5fd7bc37b6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -8,6 +8,33 @@ body: 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...?" belong on the [Neovim Discourse](https://neovim.discourse.group/c/7-category/7) and will be closed. + - type: textarea + attributes: + label: "Describe the bug" + description: "Describe the current behavior. May include logs, images, or videos." + validations: + required: true + + - type: textarea + attributes: + label: "Steps to reproduce" + description: | + - For build failures: list the exact steps including CMake flags (if any). + - For startup or shell-related problems: try `env -i TERM=ansi-256color "$(which nvim)"`. + placeholder: | + nvim --clean + :edit foo + yiwp + validations: + required: true + + - type: textarea + attributes: + label: "Expected behavior" + description: "Describe the behavior you expect." + validations: + required: true + - type: input attributes: label: "Neovim version (nvim -v)" @@ -47,29 +74,3 @@ body: placeholder: "Arch User Repository (AUR)" validations: required: true - - - type: textarea - attributes: - label: "How to reproduce the issue" - description: | - - Steps to reproduce using `nvim --clean` ("factory defaults"). - - 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 --clean - :edit foo - yiwp - validations: - required: true - - - type: textarea - attributes: - label: "Expected behavior" - description: "Describe the behavior you expect. May include logs, images, or videos." - validations: - required: true - - type: textarea - attributes: - label: "Actual behavior" - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 2b6fa3daf4..4b9a443064 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -8,14 +8,17 @@ body: value: | Before requesting: search [existing issues](https://github.com/neovim/neovim/labels/enhancement) and check the [FAQ](https://github.com/neovim/neovim/wiki/FAQ). - - type: input + - type: textarea attributes: - label: "Feature already in Vim?" - description: "Does the feature already exist in Vim? If possible, specify which version (or commit) that introduced it." - placeholder: "Yes, Vim 7.3.432" + label: "Problem" + description: "Describe the problem to be solved. Include references to other projects (Vim, Emacs, etc.) if relevant." + placeholder: "No smurf icons available. Smurfs are useful because ..." + validations: + required: true - type: textarea attributes: - label: "Feature description" + label: "Expected behavior" + description: "Describe what the new feature or behavior would look like. How does it solve the problem? Is it worth the cost?" validations: required: true diff --git a/.github/ISSUE_TEMPLATE/lsp_bug_report.yml b/.github/ISSUE_TEMPLATE/lsp_bug_report.yml index 0ed163c9be..88867ce644 100644 --- a/.github/ISSUE_TEMPLATE/lsp_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/lsp_bug_report.yml @@ -31,8 +31,38 @@ body: attributes: 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. + - Create a minimal_init.lua using vim.lsp.start: + + ```lua + --- CHANGE THESE + local pattern = 'the-filetype' + local cmd = {'name-of-language-server-executable'} + -- Add files/folders here that indicate the root of a project + local root_markers = {'.git', '.editorconfig'} + -- Change to table with settings if required + local settings = vim.empty_dict() + + vim.api.nvim_create_autocmd('FileType', { + pattern = pattern, + callback = function(args) + local match = vim.fs.find(root_markers, { path = args.file, upward = true })[1] + local root_dir = match and vim.fn.fnamemodify(match, ':p:h') or vim.NIL + vim.lsp.start({ + name = 'bugged-ls', + cmd = cmd, + root_dir = root_dir, + settings = settings + }) + end + }) + ``` + + See `:h lsp-quickstart` and `:h vim.lsp.start` for more information + + - Provide a short code example and describe the folder layout + - Describe how to trigger the issue. E.g. using `:lua vim.lsp.buf.*` commands + + _Note_: if the issue is with an autocompletion or other LSP plugin, report to that plugin's issue tracker. validations: required: true |