Skip to content

Commit e353f1f

Browse files
Add issue templates for bugs & features, based off of lazy.nvim
1 parent 56ba207 commit e353f1f

File tree

3 files changed

+75
-15
lines changed

3 files changed

+75
-15
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Bug Report
2+
description: File a bug / issue
3+
title: "bug: "
4+
labels: [bug]
5+
body:
6+
- type: input
7+
attributes:
8+
label: "Neovim version (nvim -v)"
9+
placeholder: "0.9.5"
10+
validations:
11+
required: true
12+
- type: input
13+
attributes:
14+
label: "Operating system"
15+
placeholder: "MacOS"
16+
validations:
17+
required: true
18+
- type: input
19+
attributes:
20+
label: "Terminal emulator / GUI"
21+
placeholder: "WezTerm"
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Describe the bug
27+
description: A description of what the bug is. Please include any related errors you see.
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Expected behavior
33+
description: A description of what you expected to happen.
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: Additional information
39+
description: Any additional information you would like to provide.
40+
validations:
41+
required: false
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Feature Request
2+
description: Suggest a new feature
3+
title: "feature: "
4+
labels: [enhancement]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Is your feature request related to a problem? Please describe.
9+
description: A description of what the problem is. Ex. I'm always frustrated when [...]
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Describe the solution you'd like
15+
description: A description of what you want to happen.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Describe alternatives you've considered
21+
description: A description of any alternative solutions or features you've considered.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Additional information
27+
description: Any additional information you would like to provide.
28+
validations:
29+
required: false

TROUBLESHOOTING.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,7 @@ the `filetype` of the current buffer and make sure it is in that list:
3131
:lua vim.print(vim.bo.filetype)
3232
```
3333

34-
## Create an Issue
35-
36-
Create an issue in this repo with the following information:
37-
38-
- Description of your problem
39-
- Operating system
40-
- Version of neovim
41-
- Terminal emulator / GUI
42-
- Debug logs, steps to generate these are below
43-
44-
### Generating debug logs
34+
## Generating debug logs
4535

4636
If all else fails hopefully the logs can provide some insight. This plugin
4737
ships with logging, however it only includes errors by default.
@@ -53,7 +43,7 @@ To help debug your issue you'll need to go through the following steps:
5343
3. Generate logs from the test file
5444
4. Provide the logs in the issue
5545

56-
#### Update the log level to `debug`
46+
### Update the log level to `debug`
5747

5848
Change the plugin configuration to:
5949

@@ -63,7 +53,7 @@ require('render-markdown').setup({
6353
})
6454
```
6555

66-
#### Create a test file
56+
### Create a test file
6757

6858
Create a new `markdown` file locally with the following content:
6959

@@ -80,13 +70,13 @@ Create a new `markdown` file locally with the following content:
8070
- [x] Checked
8171
```
8272

83-
#### Generate logs from the test file
73+
### Generate logs from the test file
8474

8575
To do this restart Neovim and open the `markdown` file from the previous step.
8676

8777
This should trigger the render function by default, then close Neovim.
8878

89-
#### Provide the logs in the issue
79+
### Provide the logs in the issue
9080

9181
Logs are written to a file typically located at: `~/.local/state/nvim/render-markdown.log`.
9282

0 commit comments

Comments
 (0)