Skip to content

Commit 6a5b209

Browse files
authored
Improve bug report flow (#722)
1 parent 42ff4c8 commit 6a5b209

File tree

3 files changed

+69
-23
lines changed

3 files changed

+69
-23
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: "Bug report"
2+
description: Report an issue with vanilla-extract
3+
labels: [pending triage]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please note issues should only be used for actual issues. Any feature requests or general feedback should be raised in Github Discussions (https://github.com/seek-oss/vanilla-extract/discussions) or Discord (https://discord.gg/6nCfPwwz6w)
9+
- type: textarea
10+
id: bug-description
11+
attributes:
12+
label: Describe the bug
13+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
14+
placeholder: Bug description
15+
validations:
16+
required: true
17+
- type: input
18+
id: reproduction
19+
attributes:
20+
label: Reproduction
21+
description: Add a link to a repo or codesandbox showcasing a [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) of the issue. Issues without a reproduction will likely be closed without action.
22+
placeholder: Reproduction
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: system-info
27+
attributes:
28+
label: System Info
29+
description: Output of `npx envinfo --system --npmPackages '{@vanilla-extract/*,webpack,esbuild,vite,rollup}' --binaries --browsers`
30+
render: shell
31+
placeholder: System, Binaries, Browsers
32+
validations:
33+
required: true
34+
- type: dropdown
35+
id: package-manager
36+
attributes:
37+
label: Used Package Manager
38+
description: Select the used package manager
39+
options:
40+
- npm
41+
- yarn
42+
- pnpm
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: logs
47+
attributes:
48+
label: Logs
49+
description: |
50+
Any error logging you are seeing as a result of your issue. Please try not to insert an image but copy paste the log text.
51+
render: shell
52+
- type: checkboxes
53+
id: checkboxes
54+
attributes:
55+
label: Validations
56+
description: Before submitting the issue, please make sure you do the following
57+
options:
58+
- label: Check that there isn't [already an issue](https://github.com/seek-oss/vanilla-extract/issues) that reports the same bug to avoid creating a duplicate.
59+
required: true
60+
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
61+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Feature requests, Questions & Discussions
4+
url: https://github.com/seek-oss/vanilla-extract/discussions
5+
about: Use GitHub discussions for message-board style questions and discussions
6+
- name: Discord Chat
7+
url: https://discord.gg/6nCfPwwz6w
8+
about: Ask questions and discuss with other vanilla-extract users in real time.

0 commit comments

Comments
 (0)