Skip to content

Commit 2a01b8a

Browse files
committed
Add GitHub issue templates for bug reports
Introduces a bug report issue template and disables blank issues to standardize bug reporting and improve issue triage.
1 parent 50544d1 commit 2a01b8a

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: 'Bug Report'
2+
description: 'File a bug report.'
3+
labels: ['Bug', 'Help Wanted']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Bug reports for the Serial library!
9+
10+
- type: checkboxes
11+
id: checkboxes
12+
attributes:
13+
label: Validations
14+
description: 'Before submitting the issue, please make sure you do the following'
15+
options:
16+
- label: "Check that there isn't already an issue that reports the same bug to avoid creating a duplicate."
17+
required: true
18+
19+
- type: input
20+
id: serial-library-version
21+
attributes:
22+
label: 'Serial library version'
23+
description: 'What version of the Serial library did you use when encountering the bug?'
24+
placeholder: 'ex. v1.2.0'
25+
validations:
26+
required: true
27+
28+
- type: input
29+
id: deno-version
30+
attributes:
31+
label: 'Deno version'
32+
description: 'What version of Deno do you use? Use `deno -V` to get the version of Deno.'
33+
placeholder: 'ex. v2.5.1'
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: bug-description
39+
attributes:
40+
label: What happened?
41+
description: 'What did you expect to happen?'
42+
placeholder: 'Tell us, what kind of bug you did encounter...'
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: error-message
48+
attributes:
49+
label: 'Log output (ex. errors)'
50+
description: 'Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.'
51+
render: text

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)