build: rewrite issue templates
Problem: issue templates used upstream stevearc references, severity dropdowns, outdated lazy.nvim bootstrap, and the .yml extension inconsistent with other repos. Solution: replace with .yaml templates matching cp.nvim/diffs.nvim style. Bug report uses prerequisites checkboxes, checkhealth output, modern lazy.nvim bootstrap with vim.g.oil pattern. Feature request uses problem/solution/alternatives format. Add config.yaml to disable blank issues and link discussions.
This commit is contained in:
parent
26eedd05de
commit
8d14f88f00
5 changed files with 115 additions and 174 deletions
80
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
80
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
|
|
@ -0,0 +1,80 @@
|
||||||
|
name: Bug Report
|
||||||
|
description: Report a bug
|
||||||
|
title: 'bug: '
|
||||||
|
labels: [bug]
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Prerequisites
|
||||||
|
options:
|
||||||
|
- label:
|
||||||
|
I have searched [existing
|
||||||
|
issues](https://github.com/barrettruth/oil.nvim/issues)
|
||||||
|
required: true
|
||||||
|
- label: I have updated to the latest version
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: 'Neovim version'
|
||||||
|
description: 'Output of `nvim --version`'
|
||||||
|
render: text
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: 'Operating system'
|
||||||
|
placeholder: 'e.g. Arch Linux, macOS 15, Ubuntu 24.04'
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: What happened? What did you expect?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Minimal steps to trigger the bug
|
||||||
|
value: |
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: 'Health check'
|
||||||
|
description: 'Output of `:checkhealth oil`'
|
||||||
|
render: text
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Minimal reproduction
|
||||||
|
description: |
|
||||||
|
Save the script below as `repro.lua`, edit if needed, and run:
|
||||||
|
```
|
||||||
|
nvim -u repro.lua
|
||||||
|
```
|
||||||
|
Confirm the bug reproduces with this config before submitting.
|
||||||
|
render: 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.nvim').setup({
|
||||||
|
spec = {
|
||||||
|
{
|
||||||
|
'barrettruth/oil.nvim',
|
||||||
|
init = function()
|
||||||
|
vim.g.oil = {}
|
||||||
|
end,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
131
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
131
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,131 +0,0 @@
|
||||||
name: Bug Report
|
|
||||||
description: File a bug/issue
|
|
||||||
title: "bug: "
|
|
||||||
labels: [bug]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Before reporting a bug, make sure to search [existing issues](https://github.com/stevearc/oil.nvim/issues)
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Did you check the docs and existing issues?
|
|
||||||
options:
|
|
||||||
- label: I have read the docs
|
|
||||||
required: true
|
|
||||||
- label: I have searched the existing issues
|
|
||||||
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: dropdown
|
|
||||||
attributes:
|
|
||||||
label: What is the severity of this bug?
|
|
||||||
options:
|
|
||||||
- minor (annoyance)
|
|
||||||
- tolerable (can work around it)
|
|
||||||
- breaking (some functionality is broken)
|
|
||||||
- blocking (cannot use plugin)
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Steps To Reproduce
|
|
||||||
description: Steps to reproduce the behavior.
|
|
||||||
placeholder: |
|
|
||||||
1. nvim -u repro.lua
|
|
||||||
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: Directory structure
|
|
||||||
description: The structure of the directory used to reproduce the bug
|
|
||||||
placeholder: |
|
|
||||||
a/b/foo.txt
|
|
||||||
a/bar.md
|
|
||||||
a/c/baz.txt
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Repro
|
|
||||||
description:
|
|
||||||
Minimal `init.lua` to reproduce this issue. Save as `repro.lua` and run with `nvim -u repro.lua`
|
|
||||||
This uses lazy.nvim (a plugin manager).
|
|
||||||
You can add your config with the `config` key the same way you can do with packer.nvim.
|
|
||||||
value: |
|
|
||||||
-- save as repro.lua
|
|
||||||
-- run with nvim -u repro.lua
|
|
||||||
-- DO NOT change the paths
|
|
||||||
local root = vim.fn.fnamemodify("./.repro", ":p")
|
|
||||||
|
|
||||||
-- set stdpaths to use .repro
|
|
||||||
for _, name in ipairs({ "config", "data", "state", "runtime", "cache" }) do
|
|
||||||
vim.env[("XDG_%s_HOME"):format(name:upper())] = root .. "/" .. name
|
|
||||||
end
|
|
||||||
|
|
||||||
-- bootstrap lazy
|
|
||||||
local lazypath = root .. "/plugins/lazy.nvim"
|
|
||||||
if not vim.loop.fs_stat(lazypath) then
|
|
||||||
vim.fn.system({
|
|
||||||
"git",
|
|
||||||
"clone",
|
|
||||||
"--filter=blob:none",
|
|
||||||
"--single-branch",
|
|
||||||
"https://github.com/folke/lazy.nvim.git",
|
|
||||||
lazypath,
|
|
||||||
})
|
|
||||||
end
|
|
||||||
vim.opt.runtimepath:prepend(lazypath)
|
|
||||||
|
|
||||||
-- install plugins
|
|
||||||
local plugins = {
|
|
||||||
"folke/tokyonight.nvim",
|
|
||||||
{
|
|
||||||
"stevearc/oil.nvim",
|
|
||||||
config = function()
|
|
||||||
require("oil").setup({
|
|
||||||
-- add any needed settings here
|
|
||||||
})
|
|
||||||
end,
|
|
||||||
},
|
|
||||||
-- add any other plugins here
|
|
||||||
}
|
|
||||||
require("lazy").setup(plugins, {
|
|
||||||
root = root .. "/plugins",
|
|
||||||
})
|
|
||||||
|
|
||||||
vim.cmd.colorscheme("tokyonight")
|
|
||||||
-- add anything else here
|
|
||||||
render: Lua
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Did you check the bug with a clean config?
|
|
||||||
options:
|
|
||||||
- label: I have confirmed that the bug reproduces with `nvim -u repro.lua` using the repro.lua file above.
|
|
||||||
required: true
|
|
||||||
5
.github/ISSUE_TEMPLATE/config.yaml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yaml
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Questions
|
||||||
|
url: https://github.com/barrettruth/oil.nvim/discussions
|
||||||
|
about: Ask questions and discuss ideas
|
||||||
30
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
30
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
name: Feature Request
|
||||||
|
description: Suggest a feature
|
||||||
|
title: 'feat: '
|
||||||
|
labels: [enhancement]
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Prerequisites
|
||||||
|
options:
|
||||||
|
- label:
|
||||||
|
I have searched [existing
|
||||||
|
issues](https://github.com/barrettruth/oil.nvim/issues)
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Problem
|
||||||
|
description: What problem does this solve?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Proposed solution
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Alternatives considered
|
||||||
43
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
43
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -1,43 +0,0 @@
|
||||||
name: Feature Request
|
|
||||||
description: Submit a feature request
|
|
||||||
title: "feature request: "
|
|
||||||
labels: [enhancement]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Before submitting a feature request, make sure to search for [existing requests](https://github.com/stevearc/oil.nvim/issues)
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Did you check existing requests?
|
|
||||||
options:
|
|
||||||
- label: I have searched the existing issues
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Describe the feature
|
|
||||||
description: A short summary of the feature you want
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Provide background
|
|
||||||
description: Describe the reasoning behind why you want the feature.
|
|
||||||
placeholder: I am trying to do X. My current workflow is Y.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: What is the significance of this feature?
|
|
||||||
options:
|
|
||||||
- nice to have
|
|
||||||
- strongly desired
|
|
||||||
- cannot use this plugin without it
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Additional details
|
|
||||||
description: Any additional information you would like to provide. Things you've tried, alternatives considered, examples from other plugins, etc.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue