Skip to content

Commit 0aaab36

Browse files
committed
Add issue templates
1 parent a3e606c commit 0aaab36

File tree

3 files changed

+112
-0
lines changed

3 files changed

+112
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Bug
2+
description: Report an issue with the library
3+
title: 'Bug: <title>'
4+
labels:
5+
- bug
6+
assignees:
7+
- OptimumCode
8+
body:
9+
- type: checkboxes
10+
attributes:
11+
label: Is there an existing issue for this?
12+
description: Please search to see if an issue already exists for the bug you encountered.
13+
options:
14+
- label: I have searched the existing issues
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Current Behavior
19+
description: A concise description of what you're experiencing.
20+
validations:
21+
required: false
22+
- type: textarea
23+
attributes:
24+
label: Expected Behavior
25+
description: A concise description of what you expected to happen.
26+
validations:
27+
required: false
28+
- type: textarea
29+
attributes:
30+
label: JSON schema
31+
description: A JSON schema that results in the observed behavior
32+
placeholder: |
33+
{}
34+
render: json
35+
validations:
36+
required: false
37+
- type: input
38+
attributes:
39+
label: Library version
40+
description: Version of the library which you used when experienced the problem
41+
placeholder: '0.0.1'
42+
validations:
43+
required: true
44+
- type: textarea
45+
attributes:
46+
label: Anything else?
47+
description: |
48+
Links? References? Anything that will give us more context about the issue you are encountering!
49+
50+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
51+
validations:
52+
required: false
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature request
2+
description: Enhancement proposal for the library
3+
title: 'Enhancement: <title>'
4+
labels:
5+
- enhancement
6+
assignees:
7+
- OptimumCode
8+
body:
9+
- type: checkboxes
10+
attributes:
11+
label: Is there an existing issue for this?
12+
description: Please search to see if a similar issue already exists for the bug you encountered.
13+
options:
14+
- label: I have searched the existing issues
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Enhancement description
19+
description: A description of what would like to add/change in the library.
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Anything else?
25+
description: |
26+
Links? References? Examples? Anything that will help to better understand your proposal
27+
28+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
29+
validations:
30+
required: false

.github/ISSUE_TEMPLATE/question.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Question
2+
description: Ask a question about the library or about its behavior in certain cases
3+
title: 'Question: <title>'
4+
labels:
5+
- question
6+
assignees:
7+
- OptimumCode
8+
body:
9+
- type: checkboxes
10+
attributes:
11+
label: Is there an existing issue for this?
12+
description: Please search to see if a similar question already exists for the one you would like to ask.
13+
options:
14+
- label: I have searched the existing issues
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Question
19+
description: What would you like to know?
20+
validations:
21+
required: false
22+
- type: textarea
23+
attributes:
24+
label: Anything else?
25+
description: |
26+
Links? References? Examples? Anything else that will help to properly respond to your question!
27+
28+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
29+
validations:
30+
required: false

0 commit comments

Comments
 (0)