140 lines
4.4 KiB
YAML
140 lines
4.4 KiB
YAML
name: Bugs or configuration issues
|
|
description: If you've already asked for help with a problem and confirmed something is broken with the plugin itself, create a bug report.
|
|
title: "[Bug]: TITLE DESCRIBING THE ISSUE"
|
|
labels: ["bug"]
|
|
assignees: olimorris
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for taking the time to fill out this bug report! This form may seem onerous but it makes a resolution much quicker if I can recreate the exact problem you're facing.
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
## Test with a `minimal.lua` file
|
|
> [!IMPORTANT]
|
|
> This allows me to _recreate_ your issue on my machine. Please don't skip this step and please provide the full `minimal.lua` file
|
|
|
|
Firstly, test and run Neovim with the minimal config below. Be sure to add your Persisted.nvim config, saving to a `minimal.lua` file and adding any additional plugins you may need.
|
|
```lua
|
|
local root = "/tmp/persisted"
|
|
|
|
-- Set stdpaths to use root dir
|
|
for _, name in ipairs({ "config", "data", "state", "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)
|
|
|
|
vim.opt.sessionoptions = "buffers,curdir,folds,globals,tabpages,winpos,winsize" -- Session options to store in the session
|
|
|
|
-- Install plugins
|
|
local plugins = {
|
|
{
|
|
"olimorris/persisted.nvim",
|
|
opts = {
|
|
-- Your custom config here
|
|
}
|
|
},
|
|
-- Put any other plugins here
|
|
}
|
|
require("lazy").setup(plugins, {
|
|
root = root .. "/plugins",
|
|
})
|
|
```
|
|
|
|
Once you've updated for your config, run Neovim with this command:
|
|
```sh
|
|
nvim --clean -u minimal.lua
|
|
```
|
|
|
|
Open some buffers and save the session with:
|
|
```sh
|
|
:SessionSave
|
|
```
|
|
|
|
Then re-open neovim and load the session with:
|
|
```sh
|
|
:SessionLoad
|
|
```
|
|
|
|
- type: textarea
|
|
id: persisted-config
|
|
attributes:
|
|
label: Your `minimal.lua` config
|
|
description: Please paste your minimal.lua config from above, here
|
|
placeholder: |
|
|
```lua
|
|
-- Your minimal.lua config here
|
|
```
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: errors
|
|
attributes:
|
|
label: Error messages
|
|
description: Please paste any error messages you receive
|
|
placeholder: |
|
|
```lua
|
|
-- Error messages here
|
|
```
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: bug
|
|
attributes:
|
|
label: Describe the bug
|
|
description: Please describe what you expect to happen and what is actually happening. Screenshots may be useful
|
|
placeholder: |
|
|
### What I expect to happen
|
|
[Your text here]
|
|
|
|
### What actually happens
|
|
[Your text here]
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: reproduce
|
|
attributes:
|
|
label: Reproduce the bug
|
|
description: Please include the steps so I can reproduce the bug
|
|
placeholder: |
|
|
Steps to reproduce:
|
|
1.
|
|
2.
|
|
3.
|
|
validations:
|
|
required: false
|
|
|
|
- type: checkboxes
|
|
id: final-checks
|
|
attributes:
|
|
label: Final checks
|
|
description: |
|
|
Before you submit, please make sure you have completed the following steps:
|
|
options:
|
|
- label: I have made sure this issue exists in the latest version of the plugin
|
|
required: true
|
|
- label: I have tested with the `minimal.lua` config file above and still get the issue
|
|
required: true
|
|
- label: I have used `SessionSave` to save the session before restarting Neovim and using `SessionLoad`
|
|
required: true
|
|
- label: I have made sure this is not a duplicate issue
|
|
required: true
|