Skip to content

Commit d567115

Browse files
committed
build: update issue template for bug reports
1 parent ac4e059 commit d567115

File tree

2 files changed

+73
-38
lines changed

2 files changed

+73
-38
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 38 deletions
This file was deleted.
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: "\U0001F41E Bug report"
2+
description: Create a report to help us improve
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
**Before You Start...**
8+
9+
This form is only for submitting bug reports. If you have a usage question
10+
or are unsure if this is really a bug, make sure to:
11+
12+
- Read the [docs](https://fengyuanchen.github.io/viewerjs)
13+
- Ask on [GitHub Discussions](https://github.com/fengyuanchen/viewerjs/discussions)
14+
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/ask?tags=viewerjs)
15+
16+
Also try to search for your issue - it may have already been answered or even fixed in the development branch.
17+
However, if you find that an old, closed issue still persists in the latest version,
18+
you should open a new issue using the form below instead of commenting on the old issue.
19+
- type: input
20+
id: version
21+
attributes:
22+
label: Viewer version
23+
validations:
24+
required: true
25+
- type: input
26+
id: reproduction-link
27+
attributes:
28+
label: Link to minimal reproduction
29+
description: |
30+
The easiest way to provide a reproduction is by showing the bug in the [Playground](https://fengyuanchen.github.io/viewerjs).
31+
If it cannot be reproduced in the playground and requires a proper build setup, try [StackBlitz](https://stackblitz.com/?starters=frontend).
32+
If neither of these are suitable, you can always provide a GitHub repository.
33+
34+
The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed
35+
to show the bug.
36+
37+
Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided.
38+
placeholder: Reproduction Link
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: steps-to-reproduce
43+
attributes:
44+
label: Steps to reproduce
45+
description: |
46+
What do we need to do after opening your repro in order to make the bug happen? Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code.
47+
placeholder: Steps to reproduce
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: expected
52+
attributes:
53+
label: What is expected?
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: actually-happening
58+
attributes:
59+
label: What is actually happening?
60+
validations:
61+
required: true
62+
- type: textarea
63+
id: system-info
64+
attributes:
65+
label: System Info
66+
description: Output of `npx envinfo --system --npmPackages viewerjs --binaries --browsers`
67+
render: shell
68+
placeholder: System, Binaries, Browsers
69+
- type: textarea
70+
id: additional-comments
71+
attributes:
72+
label: Any additional comments?
73+
description: e.g. some background/context of how you ran into this bug.

0 commit comments

Comments
 (0)