-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci(issue-template): add issue templates for feature request and bug r…
…eport (#3)
- Loading branch information
1 parent
38a0e63
commit efcac9a
Showing
2 changed files
with
119 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
name: Bug Report | ||
description: File a bug/issue | ||
title: "bug: " | ||
labels: [bug] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
**Before** reporting an issue, make sure to read the [documentation](https://github.com/LazyVim/LazyVim) | ||
and search [existing issues](https://github.com/LazyVim/LazyVim/issues). | ||
Usage questions such as ***"How do I...?"*** belong in [Discussions](https://github.com/LazyVim/LazyVim/discussions) and will be closed. | ||
- type: checkboxes | ||
attributes: | ||
label: Did you check docs and existing issues? | ||
description: Make sure you checked all of the below before submitting an issue | ||
options: | ||
- label: I have read all the LazyVim docs | ||
required: true | ||
- label: I have updated the plugin to the latest version before submitting this issue | ||
required: true | ||
- label: I have searched the existing issues of LazyVim | ||
required: true | ||
- label: I have searched the existing issues of plugins related to this issue | ||
required: true | ||
- type: input | ||
attributes: | ||
label: "Neovim version (nvim -v)" | ||
placeholder: "0.8.0 commit db1b0ee3b30f" | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: "Operating system/version" | ||
placeholder: "MacOS 11.5" | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is. Please include any related errors you see in Neovim. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Steps To Reproduce | ||
description: Steps to reproduce the behavior. | ||
placeholder: | | ||
1. | ||
2. | ||
3. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected Behavior | ||
description: A concise description of what you expected to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Repro | ||
description: Minimal `init.lua` to reproduce this issue. Save as `repro.lua` and run with `nvim -u repro.lua` | ||
value: | | ||
vim.env.LAZY_STDPATH = ".repro" | ||
load(vim.fn.system("curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua"))() | ||
require("lazy.minit").repro({ | ||
spec = { | ||
{ "LazyVim/LazyVim", import = "lazyvim.plugins" }, | ||
-- add any other plugins here | ||
}, | ||
}) | ||
render: lua | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: Feature Request | ||
description: Suggest a new feature | ||
title: "feature: " | ||
labels: [enhancement] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
**IMPORTANT:** ideas or requests related to extras, should go in the [Extra Requests](https://github.com/LazyVim/LazyVim/discussions/categories/extra-requests) | ||
discussion forum. | ||
- type: checkboxes | ||
attributes: | ||
label: Did you check the docs? | ||
description: Make sure you read all the docs before submitting a feature request | ||
options: | ||
- label: I have read all the LazyVim docs | ||
required: true | ||
- label: This is not a request for a new or existing extra (see above) | ||
required: true | ||
- type: textarea | ||
validations: | ||
required: true | ||
attributes: | ||
label: Is your feature request related to a problem? Please describe. | ||
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
- type: textarea | ||
validations: | ||
required: true | ||
attributes: | ||
label: Describe the solution you'd like | ||
description: A clear and concise description of what you want to happen. | ||
- type: textarea | ||
validations: | ||
required: true | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: A clear and concise description of any alternative solutions or features you've considered. | ||
- type: textarea | ||
validations: | ||
required: false | ||
attributes: | ||
label: Additional context | ||
description: Add any other context or screenshots about the feature request here. |