Skip to content

Commit 2bfe8d2

Browse files
committed
docs: issue templates
1 parent 71dac1c commit 2bfe8d2

File tree

3 files changed

+90
-30
lines changed

3 files changed

+90
-30
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
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 the documentation and search existing issues. Usage questions such as ***"How do I...?"*** belong in 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 plugin docs
16+
required: true
17+
- label: I have searched the existing issues
18+
required: true
19+
- label: I have searched the existing issues of plugins related to this issue
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: Steps To Reproduce
42+
description: Steps to reproduce the behavior.
43+
placeholder: |
44+
1.
45+
2.
46+
3.
47+
validations:
48+
required: true
49+
- type: textarea
50+
attributes:
51+
label: Expected Behavior
52+
description: A concise description of what you expected to happen.
53+
validations:
54+
required: true

.github/ISSUE_TEMPLATE/crash-report.md

Lines changed: 0 additions & 30 deletions
This file was deleted.
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: true
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)