Skip to content

Commit 1d0664c

Browse files
authored
feat: Added issue templates (#6)
1 parent 721ce0f commit 1d0664c

File tree

3 files changed

+125
-0
lines changed

3 files changed

+125
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: '🐛 Bug Report'
2+
description: 'Submit a bug report'
3+
title: '🐛 Bug: '
4+
labels: [ 'type: bug' ]
5+
body:
6+
- type: textarea
7+
id: description
8+
validations:
9+
required: true
10+
attributes:
11+
label: '📜 Description'
12+
description: 'A clear and concise description of what the bug is.'
13+
placeholder: 'It bugs out when ...'
14+
- type: textarea
15+
id: steps-to-reproduce
16+
validations:
17+
required: true
18+
attributes:
19+
label: '👟 Reproduction steps'
20+
description: 'How do you trigger this bug? Please walk us through it step by step.'
21+
placeholder: "1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error"
22+
- type: textarea
23+
id: expected-behavior
24+
validations:
25+
required: true
26+
attributes:
27+
label: '👍 Expected behavior'
28+
description: 'What did you think should happen?'
29+
placeholder: 'It should ...'
30+
- type: textarea
31+
id: actual-behavior
32+
validations:
33+
required: true
34+
attributes:
35+
label: '👎 Actual Behavior'
36+
description: 'What did actually happen? Add screenshots, if applicable.'
37+
placeholder: 'It actually ...'
38+
- type: input
39+
id: release-version
40+
validations:
41+
required: false
42+
attributes:
43+
label: release version
44+
description: Mention the release version of the software you are using.
45+
placeholder: v1.2.3
46+
- type: textarea
47+
id: additional-context
48+
validations:
49+
required: false
50+
attributes:
51+
label: '📃 Provide any additional context for the Bug.'
52+
description: 'Add any other context about the problem here.'
53+
placeholder: 'It actually ...'
54+
- type: checkboxes
55+
id: no-duplicate-issues
56+
attributes:
57+
label: '👀 Have you spent some time to check if this bug has been found before?'
58+
options:
59+
- label: "I checked and didn't find a similar issue"
60+
required: true
+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: 🚀 Feature
2+
description: 'Submit a proposal for a new feature'
3+
title: '🚀 Feature: '
4+
labels: [ feature ]
5+
body:
6+
- type: textarea
7+
id: feature-description
8+
validations:
9+
required: true
10+
attributes:
11+
label: '🔖 Feature description'
12+
description: 'A clear and concise description of what the feature is.'
13+
placeholder: 'You should add ...'
14+
- type: textarea
15+
id: pitch
16+
validations:
17+
required: true
18+
attributes:
19+
label: '🎤 Why is this feature needed ?'
20+
description: 'Please explain why this feature should be implemented and how it would be used. Add examples, if
21+
applicable.'
22+
placeholder: 'In my use-case, ...'
23+
- type: textarea
24+
id: solution
25+
validations:
26+
required: true
27+
attributes:
28+
label: '✌️ How do you aim to achieve this?'
29+
description: 'A clear and concise description of what you want to happen.'
30+
placeholder: 'I want this feature to, ...'
31+
- type: textarea
32+
id: alternative
33+
validations:
34+
required: false
35+
attributes:
36+
label: '🔄️ Additional Information'
37+
description: "A clear and concise description of any alternative solutions or additional solutions you've considered."
38+
placeholder: 'I tried, ...'
39+
- type: checkboxes
40+
id: no-duplicate-issues
41+
attributes:
42+
label: '👀 Have you spent some time to check if this feature request has been raised before?'
43+
options:
44+
- label: "I checked and didn't find similar issue"
45+
required: true
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: '❔ Question'
2+
description: 'Submit a general question to the community.'
3+
title: '❔ Question: '
4+
labels: [ 'type: question' ]
5+
body:
6+
- type: textarea
7+
id: description
8+
validations:
9+
required: true
10+
attributes:
11+
label: '❔ What is your question?'
12+
description: 'The stage is yours. Ask away! Try to provide as much context as possible.'
13+
placeholder: 'What is the best way to ...'
14+
- type: checkboxes
15+
id: no-duplicate-issues
16+
attributes:
17+
label: '👀 Have you spent some time to check if this question has been asked before?'
18+
options:
19+
- label: "I checked and didn't find a similar issue"
20+
required: true

0 commit comments

Comments
 (0)