Skip to content

Commit 466299b

Browse files
authored
Add ISSUE_TEMPLATE (#89)
1 parent 0655c67 commit 466299b

File tree

3 files changed

+145
-0
lines changed

3 files changed

+145
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: 🐞 Bug Report
2+
description: Provide a general summary of the bug in the title below.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
**Thank you :heart: for taking the time to fill out this bug report!**
11+
- type: dropdown
12+
id: severity
13+
validations:
14+
required: true
15+
attributes:
16+
label: Severity
17+
description: How severe is the bug in your opinion?
18+
multiple: false
19+
options:
20+
- "Trivial"
21+
- "Medium"
22+
- "High"
23+
- "Critical"
24+
- "Blocker"
25+
- type: input
26+
id: version
27+
validations:
28+
required: true
29+
attributes:
30+
label: What release version, tag or commit-hash did you use?
31+
description: Please include a link if possible.
32+
placeholder: v0.1.0 or 06f432a00e4c66804202c91bdfb9c9b12823928b
33+
- type: textarea
34+
id: current-behavior
35+
validations:
36+
required: true
37+
attributes:
38+
label: Current Behavior
39+
description: Tell us what happened instead of the expected behavior.
40+
placeholder: Error message appeared when I cloned a repository...
41+
- type: textarea
42+
id: steps-to-reproduce
43+
validations:
44+
required: true
45+
attributes:
46+
label: Steps to Reproduce
47+
description: Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant
48+
placeholder: |
49+
1. ...
50+
2. ...
51+
3. ...
52+
- type: textarea
53+
id: expected-behavior
54+
validations:
55+
required: true
56+
attributes:
57+
label: Expected Behavior
58+
description: Tell us what should happen
59+
placeholder: Clone of repository shall be prune of errors.
60+
- type: textarea
61+
id: possible-solution
62+
validations:
63+
required: false
64+
attributes:
65+
label: Possible Solution
66+
description: Fix/reason of the bug suggestion
67+
placeholder: A possible solution or fix is...
68+
- type: textarea
69+
id: additional-information
70+
validations:
71+
required: false
72+
attributes:
73+
label: Additional Information
74+
description: Provide an additional detailed description / screenshots / evidences of the bug
75+
placeholder: I would like to add...
76+
- type: checkboxes
77+
id: code-of-conduct
78+
attributes:
79+
label: Code of Conduct
80+
description: By submitting this issue, you agree to follow our "Code of Conduct".
81+
options:
82+
- label: I agree to follow this project's "Code of Conduct".
83+
required: true
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: 🛠️ Feature Request
2+
description: Suggest an idea to help us improve our product.
3+
title: "[Feature]: "
4+
labels:
5+
- "enhancement"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
**Thank you :heart: for taking the time to fill out this feature request report!**
11+
We kindly ask you to search if an issue already exists for your requested feature.
12+
13+
We are happy about contributions from all users.
14+
- type: textarea
15+
attributes:
16+
label: Description
17+
description: |
18+
A clear and concise description of the feature you're interested in.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Suggested Solution
25+
description: |
26+
Describe the solution you'd like to be implemented. Provide a clear and concise description of what you want to happen.
27+
validations:
28+
required: false
29+
30+
- type: textarea
31+
attributes:
32+
label: Alternatives
33+
description: |
34+
Describe alternatives you've considered.
35+
A clear and concise description of alternative solutions or features you've considered.
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
attributes:
41+
label: Additional Context
42+
description: |
43+
Add any other context about the problem here.
44+
validations:
45+
required: false

.github/ISSUE_TEMPLATE/question.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: ❓ Question or general issue
2+
description: Approach us with a question
3+
title: "[Q]: "
4+
labels:
5+
- question
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
**We are happy that you have a question to ask!**
11+
- type: textarea
12+
validations:
13+
required: true
14+
attributes:
15+
label: Question
16+
description: Feel free to ask us if you need assistance
17+
placeholder: How can I create a repository based on your template?

0 commit comments

Comments
 (0)