Skip to content

Commit 45d09ae

Browse files
committed
MNT: add documentation issue template
1 parent 6060062 commit 45d09ae

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: 📚 Documentation Issue/Suggestion
2+
description: Report problems with the docs or suggest improvements
3+
labels: [documentation]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem
9+
description: |
10+
If you are referencing an existing piece of documentation or example please provide a link.
11+
12+
Examples:
13+
- I found [...] to be unclear because [...]
14+
- [...] made me think that [...] when really it should be [...]
15+
- There is no example showing how to do [...]
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: suggested-improvement
20+
attributes:
21+
label: Suggested Improvement
22+
description: |
23+
If you have an idea to improve the documentation please suggest it here.
24+
25+
Examples:
26+
- This line should be changed to say [...]
27+
- Include a paragraph explaining [...]
28+
- Add a figure showing [...]
29+
validations:
30+
required: false

0 commit comments

Comments
 (0)