Skip to content

Commit adbaebe

Browse files
authored
feat: add issue templates (#44)
2 parents fb0552f + 696b7b7 commit adbaebe

File tree

2 files changed

+131
-0
lines changed

2 files changed

+131
-0
lines changed
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Bug Report
2+
description: Provide supporting details for a bug in the Datum Cloud Platform.
3+
labels:
4+
- bug
5+
type: Bug
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: "Overview"
10+
description: "Provide a concise summary of the bug."
11+
placeholder: "Include a short explanation of the gap or need."
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: "Steps to Reproduce"
17+
description: "Please provide detailed steps to reproduce the bug. Number each step."
18+
placeholder: |
19+
1. Go to '...'
20+
2. Click on '....'
21+
3. Scroll down to '....'
22+
4. See error
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: "Actual Behavior"
28+
description: "What actually happened when you followed the steps?"
29+
placeholder: "Describe the problem you encountered."
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: "Expected Behavior"
35+
description: "What did you expect to happen?"
36+
placeholder: "Describe what you thought should occur."
37+
validations:
38+
required: true
39+
- type: textarea
40+
attributes:
41+
label: "Environment Details"
42+
description: "Please provide details about the environment where you experienced the bug."
43+
placeholder: |
44+
- Operating System (e.g., Windows 10, macOS Sonoma 14.2.1):
45+
- Browser (e.g., Chrome 120.0.6099.129, Safari 17.2.1):
46+
- Device (e.g., Laptop, iPhone 15 Pro):
47+
- Any relevant versions (e.g., App version, specific library versions):
48+
validations:
49+
required: false
50+
- type: dropdown
51+
attributes:
52+
label: "Impact / Severity"
53+
description: "How significantly is this bug impacting your ability to use the platform?"
54+
options:
55+
- "Critical: Prevents me from using essential features or a complete outage."
56+
- "High: Significantly impairs my ability to use important features."
57+
- "Medium: Causes inconvenience but I can still use the platform with workarounds."
58+
- "Low: Minor issue or cosmetic problem with minimal impact."
59+
validations:
60+
required: false
61+
- type: textarea
62+
attributes:
63+
label: "Additional Context"
64+
description: "Add any links, references, or context you think is relevant. This could include error messages, logs, or specific data you were using."
65+
placeholder: "Provide URLs, doc references, error messages, or any other useful details."
66+
validations:
67+
required: false
68+
- type: textarea
69+
attributes:
70+
label: "Attachments / Screenshots"
71+
description: "If applicable, please provide screenshots, logs, or any other files that could help us understand the issue. You can drag and drop files here or paste links."
72+
placeholder: "Drag and drop files or paste links to attachments."
73+
validations:
74+
required: false
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Usability Feedback
2+
description: Report a usability issue or provide feedback on the user experience.
3+
labels:
4+
- usability
5+
- ux
6+
- feedback
7+
type: "Feedback"
8+
body:
9+
- type: textarea
10+
attributes:
11+
label: "What task were you trying to complete?"
12+
description: "Please describe the goal you were trying to achieve when you encountered the usability issue."
13+
placeholder: "e.g., I was trying to invite a new member to my team."
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: "Describe the usability issue"
19+
description: "Please detail the difficulty, confusion, or frustration you experienced. What happened, and where in the application did it occur?"
20+
placeholder: "e.g., I couldn't find the option to change my notification settings on the profile page."
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: "Why was this confusing or difficult for you?"
26+
description: "Help us understand your thought process. What made this part of the experience challenging from your perspective?"
27+
placeholder: "e.g., The labels were unclear, or I expected the setting to be in a different menu."
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: "What did you expect to happen instead? (Optional)"
33+
description: "If you had a different expectation for how this should function or look, please describe it."
34+
placeholder: "e.g., I expected a clear button labeled 'Notification Settings'."
35+
validations:
36+
required: false
37+
- type: textarea
38+
attributes:
39+
label: "Do you have any suggestions for improvement? (Optional)"
40+
description: "If you have ideas on how we could make this better, we'd love to hear them."
41+
placeholder: "e.g., Perhaps group all settings under a single 'Settings' menu."
42+
validations:
43+
required: false
44+
- type: input
45+
attributes:
46+
label: "Relevant URL or Section of the Application (Optional)"
47+
description: "If applicable, please provide the URL or describe the specific part of the application."
48+
placeholder: "e.g., /app/settings/notifications or 'the user profile dropdown'"
49+
validations:
50+
required: false
51+
- type: textarea
52+
attributes:
53+
label: "Attachments / Screenshots (Optional)"
54+
description: "You can drag and drop images or paste links to screenshots/recordings that illustrate the issue."
55+
placeholder: "Drag and drop or paste links here."
56+
validations:
57+
required: false

0 commit comments

Comments
 (0)