Skip to content

Commit 5c534e0

Browse files
Merge pull request #83 from ammar-knowledge/gitauto/add-issue-templates-bbf184be-ce9f-440a-a59e-432b4160c652
Add 2 issue templates
2 parents 8353436 + 5f1647b commit 5c534e0

File tree

2 files changed

+174
-0
lines changed

2 files changed

+174
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+123
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
name: Bug Report
2+
description: Create a report to identify and fix a bug
3+
title: "Bug: "
4+
labels: ["bug", "gitauto"]
5+
# assignees: [""]
6+
7+
body:
8+
- type: textarea
9+
id: bug_behavior
10+
attributes:
11+
label: Bug Behavior
12+
description: What is the bug? What is currently happening?
13+
placeholder: "Example: 'When I try to upload a file (over 100MB), the process fails with a timeout error. This disrupts my workflow and causes delays in my project.'"
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: logs
19+
attributes:
20+
label: Logs
21+
description: Include any logs such as error objects, stack traces, or console logs.
22+
placeholder: "Example: 'Error: TimeoutError: The request timed out after 30 seconds'"
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: screenshots
28+
attributes:
29+
label: Screenshots
30+
description: Add any screenshots such as error messages or unexpected behavior.
31+
placeholder: "Attach it here"
32+
validations:
33+
required: false
34+
35+
- type: input
36+
id: when_it_occurred
37+
attributes:
38+
label: When It Occurred
39+
description: When did the issue last occur?
40+
placeholder: "Example: 'Jul 10, 2024 12:08:00 AM UTC'"
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: steps_to_reproduce
46+
attributes:
47+
label: Steps to Reproduce
48+
description: How can we reproduce the bug?
49+
placeholder: |
50+
Example:
51+
1. Go to "Upload"
52+
2. Click on "Select File"
53+
3. Choose a large file (over 100MB)
54+
4. Click "Upload"
55+
5. See error
56+
value: |
57+
1.
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: expected_behavior
63+
attributes:
64+
label: Expected Behavior
65+
description: What do you expect to happen?
66+
placeholder: "Example: 'The file should upload successfully without any errors even if it's over 100MB.'"
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: possible_cause
72+
attributes:
73+
label: Possible Cause
74+
description: If you have any idea what might be causing the issue, describe it.
75+
placeholder: "Example: 'The issue may be related to the new file upload library introduced in version 1.2.3.'"
76+
validations:
77+
required: false
78+
79+
- type: input
80+
id: device
81+
attributes:
82+
label: Device
83+
description: Describe your device or server.
84+
placeholder: "MacBook Pro, 14-inch, 2023 (Check in 'About This Mac')"
85+
validations:
86+
required: true
87+
88+
- type: input
89+
id: os
90+
attributes:
91+
label: OS
92+
description: |
93+
Describe your operating system.
94+
- For Mac, check in "About This Mac".
95+
- For Windows, check in "Settings" > "System" > "About".
96+
- For iOS, check in "Settings" > "General" > "About" > "iOS Version".
97+
- For Linux, run `uname -a` in the terminal.
98+
- For your server, specify the provider such as AWS EC2, AWS Lambda, or etc.
99+
placeholder: "Sonoma 14.5"
100+
validations:
101+
required: true
102+
103+
- type: input
104+
id: browser
105+
attributes:
106+
label: Browser
107+
description: |
108+
Describe your browser.
109+
- For Chrome, "Chrome, Version 126.0.6478.127 (Official Build) (arm64)". Check in "3 dots" on the top right > "Help" > "About Google Chrome".
110+
- For Safari, "Safari, Version 17.5 (19618.2.12.11.6)". Check in "Safari" on the top left > "About Safari".
111+
- For non-browser issues, type "Server-side" or "Mobile App".
112+
placeholder: "Chrome, Version 126.0.6478.127 (Official Build) (arm64)"
113+
validations:
114+
required: true
115+
116+
- type: textarea
117+
id: additional_information
118+
attributes:
119+
label: Additional Information
120+
description: Include any other context or information.
121+
placeholder: "Describe it here"
122+
validations:
123+
required: false
+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Feature Request
2+
description: Share your problem and suggest a new feature
3+
title: "Feature Request: "
4+
labels: ["enhancement", "gitauto"]
5+
# assignees: [""]
6+
7+
body:
8+
- type: textarea
9+
id: problem
10+
attributes:
11+
label: Problem
12+
description: What issue are you facing?
13+
placeholder: "Example: 'When I try to upload large files (over 100MB), the process succeeds but takes more than 10 minutes. This disrupts my workflow and causes delays in my project.'"
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: current_solution
19+
attributes:
20+
label: Current Solution
21+
description: How are you currently solving this problem?
22+
placeholder: "Example: 'To work around this, I'm splitting the files into smaller parts (less than 50MB each) and uploading them individually. This is time-consuming and mistake-prone.'"
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: proposed_solution
28+
attributes:
29+
label: Proposed Solution
30+
description: What do you want to happen?
31+
placeholder: "Example: 'I would like a feature that supports seamless uploading of large files, more than 100MB, without any timeouts or delays. This will help me save time and improve my productivity.'"
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: attachments
37+
attributes:
38+
label: Screenshots or Diagrams
39+
description: Add any screenshots or diagrams that can help us understand the feature request.
40+
placeholder: "Attach it here"
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: additional_information
46+
attributes:
47+
label: Additional Information
48+
description: Include any other information or screenshots.
49+
placeholder: "Describe it here"
50+
validations:
51+
required: false

0 commit comments

Comments
 (0)