Skip to content

Commit 0effe0a

Browse files
committed
Create issue templates
1 parent 81cb6a5 commit 0effe0a

File tree

4 files changed

+138
-0
lines changed

4 files changed

+138
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: 🐞 Bug
2+
description: Create a bug report for something that is broken
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for reporting a bug.
9+
10+
Please fill in as much information as possible about your bug so that we don't have to play "information ping-pong" and can help you immediately.
11+
12+
- type: checkboxes
13+
id: checklist
14+
attributes:
15+
label: "Checklist"
16+
options:
17+
- label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
18+
required: true
19+
- label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
20+
required: true
21+
- label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
22+
required: true
23+
- label: "This issue contains only one bug."
24+
required: true
25+
26+
- type: input
27+
id: app-version
28+
attributes:
29+
label: Affected version
30+
description: "In which version did you encounter the bug?"
31+
placeholder: "x.x.x"
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: steps-to-reproduce
37+
attributes:
38+
label: Steps to reproduce the bug
39+
description: |
40+
What did you do for the bug to show up?
41+
42+
If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug.
43+
placeholder: |
44+
1. Use '...'
45+
2. Do '...'
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: expected-behavior
51+
attributes:
52+
label: Expected behavior
53+
description: |
54+
Tell us what you expect to happen.
55+
56+
- type: textarea
57+
id: actual-behavior
58+
attributes:
59+
label: Actual behavior
60+
description: |
61+
Tell us what happens with the steps given above.
62+
63+
- type: textarea
64+
id: additional-information
65+
attributes:
66+
label: Additional information
67+
description: |
68+
Any other relevant information you'd like to include

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: 💬 Contact support
3+
url: https://xdev.software/en/services/support
4+
about: "If you need support as soon as possible or/and you can't wait for any pull request"
5+
- name: 🐱‍💻 Security vulnerability
6+
url: https://github.com/xdev-software/template-placeholder/security/advisories/new
7+
about: "If you found a security vulnerability report it here"
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: ✨ Feature/Enhancement
2+
description: Suggest a new feature or enhancement
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for suggesting a new feature/enhancement.
9+
10+
- type: checkboxes
11+
id: checklist
12+
attributes:
13+
label: "Checklist"
14+
options:
15+
- label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
16+
required: true
17+
- label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
18+
required: true
19+
- label: "This issue contains only one feature request/enhancement."
20+
required: true
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Description
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: additional-information
31+
attributes:
32+
label: Additional information

.github/ISSUE_TEMPLATE/question.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: ❓ Question
2+
description: Ask a question
3+
labels: [question]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this form!
9+
10+
- type: checkboxes
11+
id: checklist
12+
attributes:
13+
label: "Checklist"
14+
options:
15+
- label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
16+
required: true
17+
- label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
18+
required: true
19+
20+
- type: textarea
21+
id: what-is-the-question
22+
attributes:
23+
label: What is/are your question(s)?
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: additional-information
29+
attributes:
30+
label: Additional information
31+
description: "Any other information you'd like to include - for instance logs, screenshots, etc."

0 commit comments

Comments
 (0)