Skip to content

Commit fe4fc8c

Browse files
committed
upgrade issue templates
1 parent 6133e3a commit fe4fc8c

File tree

4 files changed

+160
-48
lines changed

4 files changed

+160
-48
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
name: 🐛 Bug Report
2+
description: Report a broken functionality
3+
labels: [bug]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
- Avoid generic or vague titles such as "Something's not working" or "A couple of problems" — be as descriptive as possible.
10+
- Keep your issue focused on one single problem. If you have multiple bug reports, please create a separate issue for each of them.
11+
- Issues should represent **complete and actionable** work items. If you are unsure about something or have a question, please start a [discussion](https://github.com/jbyuki/one-small-step-for-vimkind/discussions/new) instead.
12+
13+
- type: input
14+
id: neovim-version
15+
attributes:
16+
label: "Neovim version ( `:version` )"
17+
placeholder: |
18+
NVIM v0.12.0-dev-2581+g25947a6eb8 Build type: RelWithDebInfo LuaJIT 2.1.1744317938
19+
validations:
20+
required: true
21+
22+
- type: input
23+
id: os
24+
attributes:
25+
label: "Operating System"
26+
placeholder: "Ubuntu 24.04.2 LTS"
27+
validations:
28+
required: true
29+
30+
- type: input
31+
id: description
32+
attributes:
33+
label: Describe the bug
34+
description: A clear and concise description of what the bug is. Please include any related errors you see in Neovim.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: repro
40+
attributes:
41+
label: Steps to reproduce
42+
description: Detailed explanation on how to trigger the bug and if relevant (ex. interaction with another plugin) please specify a minimal config.
43+
placeholder: |
44+
1. `mkdir ~/.config/osv_issue`
45+
2. Create init.lua in the `osv_issue` directory
46+
47+
```lua
48+
-- plugins installation
49+
local plugins = {
50+
"mfussenegger/nvim-dap",
51+
"jbyuki/one-small-step-for-vimkind",
52+
}
53+
for _, src in ipairs(plugins) do
54+
local path = vim.fs.joinpath(vim.fn.stdpath("data"), src:match("/(.*)"))
55+
src = "https://github.com/" .. src
56+
if vim.fn.isdirectory(path) == 0 then
57+
vim.fn.system { 'git', 'clone', '--depth=1', src, path }
58+
end
59+
vim.opt.runtimepath:append(path)
60+
end
61+
62+
-- if init_debug then
63+
-- require "osv".launch({ port = 8086, blocking = true })
64+
-- end
65+
66+
-- plugins configuration
67+
vim.g.mapleader = " "
68+
vim.cmd("colorscheme retrobox")
69+
vim.api.nvim_set_hl(0, "debugPC", { bg = "#cc241d" })
70+
local dap = require("dap")
71+
dap.configurations.lua = { { type = 'nlua', request = 'attach', name = "osv"} }
72+
dap.adapters.nlua = { type = 'server', host = "127.0.0.1", port = 8086, }
73+
vim.keymap.set('n', '<leader>db', require"dap".toggle_breakpoint, { noremap = true })
74+
vim.keymap.set('n', '<leader>dc', require"dap".continue, { noremap = true })
75+
vim.keymap.set('n', '<leader>do', require"dap".step_over, { noremap = true })
76+
vim.keymap.set('n', '<leader>di', require"dap".step_into, { noremap = true })
77+
78+
vim.keymap.set('n', '<leader>dl', function()
79+
require"osv".launch({port = 8086})
80+
end, { noremap = true })
81+
```
82+
83+
3. Create test.lua in home
84+
85+
```lua
86+
local sum = 0
87+
for i=1,10 do
88+
sum = sum + i
89+
end
90+
print(("The sum is %d"):format(sum))
91+
```
92+
93+
3. Launch two neovim instances (A, B)
94+
4. (A) Open `test.lua`, and place a breakpoint on the first line
95+
5. (B) Launch `osv`
96+
6. (A) Connect to (A)
97+
7. (B) Execute `test.lua` with `:luafile test.lua`
98+
validations:
99+
required: true
100+
101+
- type: textarea
102+
id: screenshot
103+
attributes:
104+
label: Screenshots
105+
description: If applicable, add screenshots to help explain your problem.
106+
value: |
107+
![DESCRIPTION](LINK.png)
108+
render: bash
109+
validations:
110+
required: false
111+
112+
- type: textarea
113+
id: logs
114+
attributes:
115+
label: Details
116+
description: Clear and thorough explanation of the bug, including any additional information you may find relevant.
117+
placeholder: |
118+
- Expected behavior: ...
119+
- Actual behavior: ...
120+
validations:
121+
required: true
122+
123+
- type: textarea
124+
id: logs
125+
attributes:
126+
label: Relevant log output
127+
description: Please copy and paste any relevant log output. These can be generated by launching `osv` with `log = true`. The log is then generated in `:=vim.fn.stdpath('data')`.
128+
render: shell
129+
validations:
130+
required: false

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: 💡 Feature Request
2+
description: Suggest a new feature
3+
labels: [ "enhancement" ]
4+
5+
body:
6+
- type: textarea
7+
validations:
8+
required: true
9+
attributes:
10+
label: Is your feature request related to a problem? Please describe.
11+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
- type: textarea
13+
validations:
14+
required: true
15+
attributes:
16+
label: Describe the solution you'd like
17+
description: A clear and concise description of what you want to happen.
18+
- type: textarea
19+
validations:
20+
required: true
21+
attributes:
22+
label: Describe alternatives you've considered
23+
description: A clear and concise description of any alternative solutions or features you've considered.
24+
25+
- type: textarea
26+
validations:
27+
required: true
28+
attributes:
29+
label: Additional context
30+
description: Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)