Skip to content

Commit 2af9e00

Browse files
committed
docs: update .github/ISSUE_TEMPLATE/bug_report.md via Apex Optimizer
1 parent 6b1e54b commit 2af9e00

File tree

1 file changed

+131
-0
lines changed

1 file changed

+131
-0
lines changed
Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in the Academic Data Science Automation Toolkit
4+
title: "Bug: [Brief Description of Bug]"
5+
labels: "bug"
6+
assignees: "chirag127"
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
### 🐛 Bug Report
13+
Please provide a clear and concise description of the bug you are experiencing. Ensure you have reviewed the [CONTRIBUTING.md](https://github.com/chirag127/Academic-Data-Science-Automation-Toolkit-Python/blob/main/.github/CONTRIBUTING.md) guidelines before submitting.
14+
15+
**Important:** For security-related issues, please refer to our [SECURITY.md](https://github.com/chirag127/Academic-Data-Science-Automation-Toolkit-Python/blob/main/.github/SECURITY.md) policy.
16+
17+
- type: markdown
18+
attributes:
19+
value: |
20+
---
21+
22+
## 1. Environment Details
23+
This section helps us understand the context in which the bug occurred.
24+
25+
- type: input
26+
id: version
27+
attributes:
28+
label: Toolkit Version
29+
description: "The specific version of the toolkit you are using (e.g., 1.2.0 or the commit hash if from main)."
30+
placeholder: "e.g., 1.2.0 / abc1234"
31+
validations:
32+
required: true
33+
34+
- type: input
35+
id: python-version
36+
attributes:
37+
label: Python Version
38+
description: "The Python version installed on your system."
39+
placeholder: "e.g., 3.11.4"
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: os
45+
attributes:
46+
label: Operating System & Version
47+
description: "Specify your OS and its version (e.g., Ubuntu 22.04, macOS Ventura 13.5, Windows 11).
48+
placeholder: "e.g., macOS Ventura 13.5 (Apple M1 Pro)"
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: dependencies
54+
attributes:
55+
label: Key Dependencies (if applicable)
56+
description: "List any specific versions of major libraries you are using, especially if they deviate from the standard toolkit dependencies."
57+
placeholder: "e.g., pandas==2.0.3, numpy==1.25.1"
58+
validations:
59+
required: false
60+
61+
- type: markdown
62+
attributes:
63+
value: |
64+
---
65+
66+
## 2. Bug Description
67+
Provide a detailed explanation of the bug.
68+
69+
- type: textarea
70+
id: description
71+
attributes:
72+
label: Describe the bug
73+
description: "What is the unexpected behavior? What did you expect to happen?"
74+
placeholder: "A clear and concise description of the bug."
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
id: steps_to_reproduce
80+
attributes:
81+
label: Steps to Reproduce
82+
description: "Provide step-by-step instructions to reproduce the bug. Be as detailed as possible."
83+
placeholder: "1. Run command `python toolkit.py process --data input.csv`\n2. Observe error message..."
84+
validations:
85+
required: true
86+
87+
- type: textarea
88+
id: expected_behavior
89+
attributes:
90+
label: Expected Behavior
91+
description: "What did you expect to happen?"
92+
placeholder: "The command should complete successfully and output results to output.txt."
93+
validations:
94+
required: true
95+
96+
- type: textarea
97+
id: actual_behavior
98+
attributes:
99+
label: Actual Behavior
100+
description: "What actually happened? Include any error messages or logs."
101+
placeholder: "The command failed with a `KeyError: 'column_name'`.
102+
Traceback:
103+
python
104+
...error traceback...
105+
"
106+
validations:
107+
required: true
108+
109+
- type: markdown
110+
attributes:
111+
value: |
112+
---
113+
114+
## 3. Additional Information
115+
Any other context about the problem.
116+
117+
- type: textarea
118+
id: additional_context
119+
attributes:
120+
label: Additional Context
121+
description: "Screenshots, logs, relevant configurations, or any other context about the problem. You can attach screenshots by dragging and dropping them."
122+
placeholder: "e.g., This bug only occurs when processing large datasets..."
123+
validations:
124+
required: false
125+
126+
- type: markdown
127+
attributes:
128+
value: |
129+
---
130+
131+
Thank you for helping improve the **Academic Data Science Automation Toolkit**!

0 commit comments

Comments
 (0)