Skip to content

Commit 7e01131

Browse files
authored
feat(issue): add bug_report, feature_request issue template (#1013)
1 parent f4a7799 commit 7e01131

File tree

2 files changed

+145
-0
lines changed

2 files changed

+145
-0
lines changed
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: Bug Report
2+
description: File a bug / issue.
3+
title: "BUG: "
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Before** reporting an issue, make sure to read [`:h neo-tree.txt`](https://github.com/nvim-neo-tree/neo-tree.nvim/blob/v2.x/doc/neo-tree.txt) and search [existing issues](https://github.com/nvim-neo-tree/neo-tree.nvim/issues). Usage questions such as ***"How do I...?"*** belong in [Discussions](https://github.com/nvim-neo-tree/neo-tree.nvim/discussions) and will be closed.
10+
- type: checkboxes
11+
attributes:
12+
label: Did you check docs and existing issues?
13+
description: Make sure you checked all of the below before submitting an issue
14+
options:
15+
- label: I have read all the docs.
16+
required: true
17+
- label: I have searched the existing issues.
18+
required: true
19+
- label: I have searched the existing discussions.
20+
required: true
21+
- type: input
22+
attributes:
23+
label: "Neovim Version (nvim -v)"
24+
placeholder: "0.8.0 commit db1b0ee3b30f"
25+
validations:
26+
required: true
27+
- type: input
28+
attributes:
29+
label: "Operating System / Version"
30+
placeholder: "MacOS 11.5"
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Describe the Bug
36+
description: A clear and concise description of what the bug is. Please include any related errors you see in Neovim.
37+
validations:
38+
required: true
39+
- type: textarea
40+
attributes:
41+
label: Screenshots, Traceback
42+
description: Screenshot and traceback if exists. Not required.
43+
validations:
44+
required: false
45+
- type: textarea
46+
attributes:
47+
label: Steps to Reproduce
48+
description: Steps to reproduce the behavior. Describe with the exact commands and keypresses.
49+
placeholder: |
50+
1.
51+
2.
52+
3.
53+
validations:
54+
required: true
55+
- type: textarea
56+
attributes:
57+
label: Expected Behavior
58+
description: A concise description of what you expected to happen.
59+
validations:
60+
required: true
61+
- type: textarea
62+
attributes:
63+
label: Your Configuration
64+
description: Minimal `init.lua` to reproduce this issue. Save as `repro.lua` and run with `nvim -u repro.lua`
65+
value: |
66+
-- DO NOT change the paths and don't remove the colorscheme
67+
local root = vim.fn.fnamemodify("./.repro", ":p")
68+
69+
-- set stdpaths to use .repro
70+
for _, name in ipairs({ "config", "data", "state", "cache" }) do
71+
vim.env[("XDG_%s_HOME"):format(name:upper())] = root .. "/" .. name
72+
end
73+
74+
-- bootstrap lazy
75+
local lazypath = root .. "/plugins/lazy.nvim"
76+
if not vim.loop.fs_stat(lazypath) then
77+
vim.fn.system({ "git", "clone", "--filter=blob:none", "https://github.com/folke/lazy.nvim.git", lazypath, })
78+
end
79+
vim.opt.runtimepath:prepend(lazypath)
80+
81+
-- install plugins
82+
local plugins = {
83+
"folke/tokyonight.nvim",
84+
-- add any other plugins here
85+
}
86+
87+
local neotree_config = {
88+
"nvim-neo-tree/neo-tree.nvim",
89+
dependencies = { "MunifTanjim/nui.nvim", "nvim-tree/nvim-web-devicons" },
90+
cmd = { "Neotree" },
91+
keys = {
92+
{ "<Leader>e", "<Cmd>Neotree<CR>" }, -- change or remove this line if relevant.
93+
},
94+
opts = {
95+
-- Your config here
96+
-- ...
97+
},
98+
}
99+
100+
table.insert(plugins, neotree_config)
101+
require("lazy").setup(plugins, {
102+
root = root .. "/plugins",
103+
})
104+
105+
vim.cmd.colorscheme("tokyonight")
106+
-- add anything else here
107+
render: Lua
108+
validations:
109+
required: false
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature Request
2+
description: Suggest a new feature.
3+
title: "FEATURE: "
4+
labels: [enhancement]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Did you check the docs?
9+
description: Make sure you read all the docs before submitting a feature request.
10+
options:
11+
- label: I have read all the docs.
12+
required: true
13+
- type: textarea
14+
validations:
15+
required: true
16+
attributes:
17+
label: Is your feature request related to a problem? Please describe.
18+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
19+
- type: textarea
20+
validations:
21+
required: true
22+
attributes:
23+
label: Describe the solution you'd like.
24+
description: A clear and concise description of what you want to happen.
25+
- type: textarea
26+
validations:
27+
required: false
28+
attributes:
29+
label: Describe alternatives you've considered.
30+
description: A clear and concise description of any alternative solutions or features you've considered.
31+
- type: textarea
32+
validations:
33+
required: false
34+
attributes:
35+
label: Additional Context
36+
description: Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)