Skip to content

Commit 4546449

Browse files
docs: add GitHub Issue Form for bug reports (#403)
1 parent 340edb6 commit 4546449

File tree

1 file changed

+181
-0
lines changed

1 file changed

+181
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
name: Bug report 🐞
2+
description: Report a bug or internal server error when using Gitingest
3+
title: "(bug): "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! :lady_beetle:
10+
11+
Please fill out the following details to help us reproduce and fix the issue. :point_down:
12+
13+
- type: dropdown
14+
id: interface
15+
attributes:
16+
label: Which interface did you use?
17+
default: 0
18+
options:
19+
- "Select one..."
20+
- Web UI
21+
- CLI
22+
- PyPI package
23+
validations:
24+
required: true
25+
26+
- type: input
27+
id: repo_url
28+
attributes:
29+
label: Repository URL (if public)
30+
placeholder: e.g., https://github.com/<username>/<repo>/commit_branch_or_tag/blob_or_tree/subdir
31+
32+
- type: dropdown
33+
id: git_host
34+
attributes:
35+
label: Git host
36+
description: The Git host of the repository.
37+
default: 0
38+
options:
39+
- "Select one..."
40+
- GitHub (github.com)
41+
- GitLab (gitlab.com)
42+
- Bitbucket (bitbucket.org)
43+
- Gitea (gitea.com)
44+
- Codeberg (codeberg.org)
45+
- Gist (gist.github.com)
46+
- Kaggle (kaggle.com)
47+
- GitHub Enterprise (github.company.com)
48+
- Other (specify below)
49+
validations:
50+
required: true
51+
52+
- type: input
53+
id: git_host_other
54+
attributes:
55+
label: Other Git host
56+
placeholder: If you selected "Other", please specify the Git host here.
57+
58+
- type: dropdown
59+
id: repo_visibility
60+
attributes:
61+
label: Repository visibility
62+
default: 0
63+
options:
64+
- "Select one..."
65+
- public
66+
- private
67+
validations:
68+
required: true
69+
70+
- type: dropdown
71+
id: revision
72+
attributes:
73+
label: Commit, branch, or tag
74+
default: 0
75+
options:
76+
- "Select one..."
77+
- default branch
78+
- commit
79+
- branch
80+
- tag
81+
validations:
82+
required: true
83+
84+
- type: dropdown
85+
id: ingest_scope
86+
attributes:
87+
label: Did you ingest the full repository or a subdirectory?
88+
default: 0
89+
options:
90+
- "Select one..."
91+
- full repository
92+
- subdirectory
93+
validations:
94+
required: true
95+
96+
- type: dropdown
97+
id: os
98+
attributes:
99+
label: Operating system
100+
default: 0
101+
options:
102+
- "Select one..."
103+
- Not relevant (Web UI)
104+
- macOS
105+
- Windows
106+
- Linux
107+
validations:
108+
required: true
109+
110+
- type: dropdown
111+
id: browser
112+
attributes:
113+
label: Browser (Web UI only)
114+
default: 0
115+
options:
116+
- "Select one..."
117+
- Not relevant (CLI / PyPI)
118+
- Chrome
119+
- Firefox
120+
- Safari
121+
- Edge
122+
- Other (specify below)
123+
validations:
124+
required: true
125+
126+
- type: input
127+
id: browser_other
128+
attributes:
129+
label: Other browser
130+
placeholder: If you selected "Other", please specify the browser here.
131+
132+
- type: input
133+
id: gitingest_version
134+
attributes:
135+
label: Gitingest version
136+
placeholder: e.g., v0.1.5
137+
description: Not required if you used the Web UI.
138+
139+
- type: input
140+
id: python_version
141+
attributes:
142+
label: Python version
143+
placeholder: e.g., 3.11.5
144+
description: Not required if you used the Web UI.
145+
146+
- type: textarea
147+
id: bug_description
148+
attributes:
149+
label: Bug description
150+
placeholder: Describe the bug here.
151+
description: A detailed but concise description of the bug.
152+
validations:
153+
required: true
154+
155+
156+
- type: textarea
157+
id: steps_to_reproduce
158+
attributes:
159+
label: Steps to reproduce
160+
placeholder: Include the exact commands or actions that led to the error.
161+
description: Include the exact commands or actions that led to the error *(if relevant)*.
162+
render: shell
163+
164+
- type: textarea
165+
id: expected_behavior
166+
attributes:
167+
label: Expected behavior
168+
placeholder: Describe what you expected to happen.
169+
description: Describe what you expected to happen *(if relevant)*.
170+
171+
- type: textarea
172+
id: actual_behavior
173+
attributes:
174+
label: Actual behavior
175+
description: Paste the full error message or stack trace here.
176+
177+
- type: textarea
178+
id: additional_context
179+
attributes:
180+
label: Additional context, logs, or screenshots
181+
placeholder: Add any other context, links, or screenshots about the issue here.

0 commit comments

Comments
 (0)