summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkylo252 <[email protected]>2021-12-27 16:18:25 +0100
committerGitHub <[email protected]>2021-12-27 16:18:25 +0100
commitfefe78d81c9ee0fa4231b11e1c623e72960f5856 (patch)
tree01d38ff9e16b1c0046e25bb8e61038d34f267338
parent5333cb3de320a13af7db305960247f66ec7f2624 (diff)
chore: update github's templates (#2116)
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml6
-rw-r--r--.github/ISSUE_TEMPLATE/feature-form.yaml23
-rw-r--r--.github/ISSUE_TEMPLATE/general-issue-form.yaml40
-rw-r--r--.github/ISSUE_TEMPLATE/lsp-issue-form.yaml93
4 files changed, 81 insertions, 81 deletions
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 219f903b..ebcfa911 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -3,7 +3,7 @@ blank_issues_enabled: true
contact_links:
- name: Matrix community
url: https://matrix.to/#/#atmachine-neovim:matrix.org
- about: Please ask and answer questions on Matrix.
+ about: Ask and discuss about LunarVim on Matrix.
- name: Discord community
- url: https://discord.gg/Xb9B4Ny
- about: Please ask and answer questions on Discord.
+ url: https://discord.com/invite/sbDcEmJHww
+ about: Ask and discuss about LunarVim on Discord.
diff --git a/.github/ISSUE_TEMPLATE/feature-form.yaml b/.github/ISSUE_TEMPLATE/feature-form.yaml
index cfd0793b..1ae52f4a 100644
--- a/.github/ISSUE_TEMPLATE/feature-form.yaml
+++ b/.github/ISSUE_TEMPLATE/feature-form.yaml
@@ -1,34 +1,25 @@
name: Feature Request
description: Suggest an idea for improving this project
-title: "[Feature]: "
labels: [enhancement]
-# assignees:
-# - ChristianChiarulli
+
body:
- type: markdown
attributes:
- value: |
- Thank you for helping us improve !
+ value: Thank you for helping us improve!
+
- type: textarea
id: motivation
attributes:
- label: Feature motivation
- description: A clear and concise description of the problem or missing capability
- placeholder: |
- I am always frustrated when ...
+ label: Feature Description
+ placeholder: What is the expected behavior of this new feature?
validations:
required: true
- type: textarea
- id: solution
- attributes:
- label: Describe the expected solution
- - type: textarea
id: alternatives
attributes:
- label: Describe the alternatives you've considered
- description: Let us know about other solutions you've tried or researched
+ label: Describe the alternatives you have considered
- type: textarea
id: additional-context
attributes:
- label: Additional context
+ label: Support information
description: If applicable, add screenshots or link related issues
diff --git a/.github/ISSUE_TEMPLATE/general-issue-form.yaml b/.github/ISSUE_TEMPLATE/general-issue-form.yaml
index 50a8e210..56fbc1dc 100644
--- a/.github/ISSUE_TEMPLATE/general-issue-form.yaml
+++ b/.github/ISSUE_TEMPLATE/general-issue-form.yaml
@@ -1,14 +1,14 @@
name: General Issue
description: File a bug report
-title: "[Bug]: "
labels: [bug]
-# assignees:
-# - ChristianChiarulli
+
body:
- type: markdown
attributes:
value: |
- Thank you for helping us improve !
+ _Before reporting:_ search [existing issues](https://github.com/lunarvim/lunarvim/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and check the [Troubleshooting guide](https://www.lunarvim.org/troubleshooting).
+ If you need real-time help, join us on Discord. Thank you for helping us improve!
+
- type: textarea
id: problem-description
attributes:
@@ -26,13 +26,25 @@ body:
id: lunar-vim-version
attributes:
label: LunarVim version
+ placeholder: |
+ output of :LvimVersion
validations:
required: true
- type: input
id: nvim-version
attributes:
- label: Neovim version (>= 0.5)
- placeholder: nvim --version
+ label: Neovim version (>= 0.6)
+ 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: "Operating system/version"
+ placeholder: "macOS 11.5"
validations:
required: true
- type: textarea
@@ -40,24 +52,14 @@ body:
attributes:
label: Relevant log output
placeholder: |
- nvim -v
:checkhealth
:messages
+ :e $LUNARVIM_CACHE/DIR/lvim.log
render: shell
+ validations:
+ required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem
- - type: checkboxes
- id: checks
- attributes:
- label: I have
- options:
- - label: Read the readme
- required: true
- - label: Read the wiki
- required: true
- - label: Searched for similar issues
- required: true
-
diff --git a/.github/ISSUE_TEMPLATE/lsp-issue-form.yaml b/.github/ISSUE_TEMPLATE/lsp-issue-form.yaml
index 2fabeee6..c0743651 100644
--- a/.github/ISSUE_TEMPLATE/lsp-issue-form.yaml
+++ b/.github/ISSUE_TEMPLATE/lsp-issue-form.yaml
@@ -1,80 +1,87 @@
name: LSP Issue
description: File a LSP related bug report
-title: "[Bug]: "
labels: [bug, lsp]
-# assignees:
-# - ChristianChiarulli
+
body:
- type: markdown
attributes:
value: |
- Thank you for helping us improve !
+ _Before reporting:_ search [existing issues](https://github.com/lunarvim/lunarvim/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and check the [Troubleshooting guide](https://www.lunarvim.org/troubleshooting).
+ If you need real-time help, join us on Discord. Thank you for helping us improve!
+
- type: textarea
id: problem-description
attributes:
label: Problem description
- description: Also tell us, what did you expect to happen?
- placeholder: |
- Steps to reproduce the behavior:
- 1. Go to '...'
- 2. Click on '....'
- 3. Scroll down to '....'
- 4. See error
+ description: "A short description of the problem you are reporting."
validations:
required: true
- - type: checkboxes
- id: generic-checks
- attributes:
- label: Check the following
- options:
- - label: I am in a git managed directory
- required: true
- - label: I restarted Neovim after running :LspInstall
- required: true
- - label: I have a valid language configuration (~/.config/lvim/ftplugin/)
- required: true
- - label: I checked the options (~/.config/lvim/config.lua)
- required: true
- - label: The programs specified by the config are installed
- type: input
id: lunar-vim-version
attributes:
label: LunarVim version
+ placeholder: |
+ output of :LvimVersion
validations:
required: true
- type: input
id: nvim-version
attributes:
- label: Neovim version (>= 0.5)
- placeholder: nvim --version
+ label: Neovim version (>= 0.6)
+ 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: "Operating system/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: "tsserver"
validations:
required: true
- type: textarea
+ attributes:
+ label: "Steps to reproduce"
+ description: "Steps to reproduce using the minimal config."
+ placeholder: |
+ 1. `nvim -u ~/.local/share/lunarvim/lvim/tests/minimal_lsp.lua`
+ 2. ...
+ - 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
id: logs
attributes:
- label: Relevant log output
+ label: log and support info
placeholder: |
- :echo &ft
:LspInfo
-
- :LspStart <language>
+ :LvimInfo
:messages
:checkhealth
- grep ERROR ~/.cache/nvim/lsp.log
+ :e $LUNARVIM_CACHE/DIR/lsp.log
+ :e $LUNARVIM_CACHE/DIR/lvim.log
+ :e $LUNARVIM_CACHE/DIR/log
render: shell
+ validations:
+ required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem
- - type: checkboxes
- id: documentation-checks
- attributes:
- label: I have
- options:
- - label: Read the readme
- required: true
- - label: Read the wiki
- required: true
- - label: Searched for similar issues
- required: true