From f557ae9081ed62f535fc582dab5fa734bea0ea71 Mon Sep 17 00:00:00 2001
From: Christian Clason <christian.clason@uni-due.de>
Date: Fri, 13 Aug 2021 09:29:06 +0200
Subject: [PATCH] chore: convert bug issue template to form (#1110)

Replace Markdown template with Github form and add more robust
minimal `init.lua`. Also add a link to Gitter for support questions.
---
 .github/ISSUE_TEMPLATE/bug_report.md  | 91 ---------------------------
 .github/ISSUE_TEMPLATE/bug_report.yml | 88 ++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml     |  6 ++
 3 files changed, 94 insertions(+), 91 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 81f225f..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,91 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-<!-- @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-> Please make sure to take the time adhere fully the following template.
-> So that the team can understand the issue and solve it very quickly,
-> else the issue will be marked "missing issue template" and
-> close right away!!!!!
-
-TODO:
-- Include test.vim content in details section (see configuration sec)
-- Add description
-- Add reproduce steps
-- Add Expected and Actual behavior
-- Include Environment information
-
-TIP: copy the template to your vim buffer
-@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -->
-
-### Description
-<!-- Whats wrong? what is not working? what Issue(s) are you facing?, when ....  -->
-
-**Expected Behavior**
-<!-- what is the Expected Behaviour in the steps you've defined above? -->
-
-**Actual Behavior**
-<!-- what is the Actual Behaviour your getting from the steps you've defined above? -->
-
-### Details
-
-<!-- Steps to reproduce -->
-<details><summary>Reproduce</summary>
-
-<!--
-Example:
-
-1. nvim -nu test.vim
-2. :Telescope live_grep or git_commits
-3. .... bang here is the issue
-...
--->
-
-1. nvim -nu test.vim
-2. 
-3. 
-</details>
-
-<!-- Environment Information -->
-<details><summary>Environment</summary>
-
-<!--
-- nvim --version
-- Operating system
-- git log --pretty=format:'%h' -n 1
-...
--->
-- nvim --version output: 
-- Operating system: 
-- Telescope commit: 
-
-</details>
-
-<!-- Configuration -->
-<details><summary>Configuration</summary>
-<p>
-<!-- adopt your telescope configuration to the following template,
-save it to test.vim then execute `nvim -NU test.vim` -->
-
-```viml
-set nocompatible hidden laststatus=2
-
-if !filereadable('/tmp/plug.vim')
-  silent !curl --insecure -fLo /tmp/plug.vim
-    \ https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
-endif
-
-source /tmp/plug.vim
-call plug#begin('/tmp/plugged')
-Plug 'nvim-lua/plenary.nvim'
-Plug 'nvim-telescope/telescope.nvim'
-call plug#end()
-
-autocmd VimEnter * PlugClean! | PlugUpdate --sync | close
-lua require('telescope').setup()
-```
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..c146355
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,88 @@
+name: Bug report
+description: Report a problem with Telescope
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before reporting: search [existing issues](https://github.com/nvim-telescope/telescope.nvim/issues) and make sure that both Telescope and its dependencies are updated to the latest version.
+  - type: textarea
+    attributes:
+      label: "Description"
+      description: "A short description of the problem you are reporting."
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: "Neovim version"
+      description: "Output of `nvim --version`"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: "Operating system and version"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Steps to reproduce"
+      description: "Steps to reproduce using the minimal config provided below."
+      value: |
+        1. `nvim -nu minimal.lua`
+        2. ...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Expected behavior"
+      description: "A description of the behavior you expected:"
+  - type: textarea
+    attributes:
+      label: "Actual behavior"
+      description: "Observed behavior (may optionally include logs, images, or videos)."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+       label: "Minimal config"
+       description: "Minimal(!) configuration necessary to reproduce the issue. Save this as `minimal.lua`. If _absolutely_ necessary, add plugins and config options from your `init.lua` at the indicated lines."
+       render: Lua
+       value: |
+         vim.cmd [[set runtimepath=$VIMRUNTIME]]
+         vim.cmd [[set packpath=/tmp/nvim/site]]
+         local package_root = '/tmp/nvim/site/pack'
+         local install_path = package_root .. '/packer/start/packer.nvim'
+         local function load_plugins()
+           require('packer').startup {
+             {
+               'wbthomason/packer.nvim',
+               {
+                 'nvim-telescope/telescope.nvim',
+                 requires = {
+                   'nvim-lua/plenary.nvim',
+                   { 'nvim-telescope/telescope-fzf-native.nvim', run = 'make' },
+                 },
+               },
+               -- ADD PLUGINS THAT ARE _NECESSARY_ FOR REPRODUCING THE ISSUE
+             },
+             config = {
+               package_root = package_root,
+               compile_path = install_path .. '/plugin/packer_compiled.lua',
+               display = { non_interactive = true },
+             },
+           }
+         end
+         _G.load_config = function()
+           require('telescope').setup()
+           require('telescope').load_extension('fzf')
+           -- ADD INIT.LUA SETTINGS THAT ARE _NECESSARY_ FOR REPRODUCING THE ISSUE
+         end
+         if vim.fn.isdirectory(install_path) == 0 then
+           print("Installing Telescope and dependencies. This may take a while!")
+           vim.fn.system { 'git', 'clone', '--depth=1', 'https://github.com/wbthomason/packer.nvim', install_path }
+         end
+         load_plugins()
+         require('packer').sync()
+         vim.cmd [[autocmd User PackerComplete ++once echo "Ready!" | lua load_config()]]
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..a5d27cd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,6 @@
+blank_issues_enabled: false
+contact_links:
+   - name: Question
+     url: https://gitter.im/nvim-telescope/community
+     about: Usage questions and support requests are answered in the Telescope Gitter
+