Skip to content

Commit ccd3a5a

Browse files
authored
chore: convert bug report template to GitHub form (#4015)
Converts the bug report issue template from markdown to GitHub's YAML form format. This provides a more structured experience for users filing bug reports with: - Required version and platform fields - Separate sections for code, expected behavior, and actual behavior - Better input validation - Improved readability for maintainers Closes #3213
1 parent 3b344ca commit ccd3a5a

File tree

2 files changed

+65
-28
lines changed

2 files changed

+65
-28
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: "Bug report 🐛"
2+
description: Create a report to help us improve
3+
labels: ["C-bug"]
4+
body:
5+
- type: input
6+
id: version
7+
attributes:
8+
label: Version
9+
description: List the version(s) of `hyper`, and any relevant hyper dependency (such as `h2` if this is related to HTTP/2).
10+
placeholder: "hyper 1.0.0, h2 0.4.0"
11+
validations:
12+
required: true
13+
14+
- type: input
15+
id: platform
16+
attributes:
17+
label: Platform
18+
description: The output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows)
19+
placeholder: "Linux 5.15.0 x86_64 / Windows 11 64-bit"
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: summary
25+
attributes:
26+
label: Summary
27+
description: A short summary of the bug
28+
placeholder: "Brief description of what went wrong"
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: code
34+
attributes:
35+
label: Code Sample
36+
description: Code sample that causes the bug (if applicable)
37+
render: rust
38+
placeholder: |
39+
use hyper::...;
40+
41+
fn main() {
42+
// code that reproduces the bug
43+
}
44+
45+
- type: textarea
46+
id: expected
47+
attributes:
48+
label: Expected Behavior
49+
description: What you expected to happen
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: actual
55+
attributes:
56+
label: Actual Behavior
57+
description: What actually happened instead
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: additional
63+
attributes:
64+
label: Additional Context
65+
description: Any other context about the problem (stack traces, related issues, etc.)

0 commit comments

Comments
 (0)