Skip to content
This repository was archived by the owner on Sep 11, 2024. It is now read-only.

Commit da90510

Browse files
authored
docs: Added Issue Templates (#330)
* Create bug.yml * Create config.yml * Create feature_request.yml * Create testimonial.yml * Delete .github/ISSUE_TEMPLATE/testimonial.yml * Changed link to discord
1 parent 257892e commit da90510

File tree

3 files changed

+143
-0
lines changed

3 files changed

+143
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: 🐛 Bug
2+
description: Report an issue to help improve the project.
3+
title: "[BUG] <description>"
4+
labels: ["🛠 goal: fix", "🚦 status: awaiting triage"]
5+
body:
6+
- type: checkboxes
7+
id: duplicates
8+
attributes:
9+
label: Has this bug been raised before?
10+
description: Increase the chances of your issue being accepted by making sure it has not been raised before.
11+
options:
12+
- label: I have checked "open" AND "closed" issues and this is not a duplicate
13+
required: true
14+
- type: input
15+
attributes:
16+
label: Where did you find this bug?
17+
description: Local dev environment or production on biodrop.io
18+
validations:
19+
required: true
20+
- type: input
21+
attributes:
22+
label: Version of BioDrop (for example "v1.2.3")
23+
description: Can be found in the lower right corner of the web interface in the footer.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: Description
30+
description: A clear description of the bug you have found. Please include relevant information and resources (for example the steps to reproduce the bug)
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: steps
35+
attributes:
36+
label: Steps to Reproduce
37+
description: To help us recreate the bug, provide a numbered list of the exact steps taken to trigger the buggy behavior.
38+
value: |
39+
If you know the steps, follow the below format and provide steps to reproduce
40+
41+
For example:
42+
43+
1. Go to <replace your> page.
44+
1. On top right side, close to the <Account> menu
45+
1. Some menu are not working properly.
46+
1. Continue...
47+
48+
If you don't know exact steps, include any relevant details like:
49+
50+
- What page you were on...
51+
- What you were trying to do...
52+
- What went wrong...
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: screenshots
57+
attributes:
58+
label: Screenshots
59+
description: Please add screenshots if applicable
60+
validations:
61+
required: false
62+
- type: dropdown
63+
id: assignee
64+
attributes:
65+
label: Do you want to work on this issue?
66+
multiple: false
67+
options:
68+
- "No"
69+
- "Yes"
70+
default: 0
71+
validations:
72+
required: false
73+
- type: textarea
74+
id: extrainfo
75+
attributes:
76+
label: If "yes" to above, please explain how you would technically implement this
77+
description: For example reference any existing code
78+
validations:
79+
required: false
80+
- type: markdown
81+
attributes:
82+
value: |
83+
You can also join our Discord community [here](http://discord.eddiehub.org)

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question?
4+
url: https://www.biodrop.io/docs/faqs
5+
about: If your question is not covered by the FAQs, please ask your question in our [EddieHub Community Discord](https://discord.eddiehub.org).
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: 💡 General Feature Request
2+
description: Have a new idea/feature for BioDrop? Let us know...
3+
title: "[FEATURE] <description>"
4+
labels: ["⭐ goal: addition", "🚦 status: awaiting triage"]
5+
body:
6+
- type: checkboxes
7+
id: duplicates
8+
attributes:
9+
label: Is this a unique feature?
10+
description: Increase the chances of your issue being accepted by making sure it has not been raised before.
11+
options:
12+
- label: I have checked "open" AND "closed" issues and this is not a duplicate
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Is your feature request related to a problem/unavailable functionality? Please describe.
17+
description: A clear and concise description of what the problem is (for example "I'm always frustrated when [...]").
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Proposed Solution
24+
description: A clear description of the enhancement you propose. Please include relevant information and resources (for example another project's implementation of this feature).
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: screenshots
29+
attributes:
30+
label: Screenshots
31+
description: Please add screenshots of the before and/or after the proposed changes.
32+
validations:
33+
required: false
34+
- type: dropdown
35+
id: assignee
36+
attributes:
37+
label: Do you want to work on this issue?
38+
multiple: false
39+
options:
40+
- "No"
41+
- "Yes"
42+
default: 0
43+
validations:
44+
required: false
45+
- type: textarea
46+
id: extrainfo
47+
attributes:
48+
label: If "yes" to above, please explain how you would technically implement this
49+
description: For example reference any existing code
50+
validations:
51+
required: false
52+
- type: markdown
53+
attributes:
54+
value: |
55+
You can also join our Discord community [here](http://discord.eddiehub.org)

0 commit comments

Comments
 (0)