Skip to content

Commit 163b544

Browse files
committed
Issue template refinement
1 parent b70eea7 commit 163b544

File tree

1 file changed

+57
-10
lines changed

1 file changed

+57
-10
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,65 @@
11
name: Bug Report
2-
description:
2+
description: Something does not work as expected
33
title: "[Bug]"
44
labels: bug
55
body:
66
- type: markdown
77
attributes:
88
value: |
99
Thank you for taking the time to report a bug!
10-
First, please understand this repo is called deck.gl-community because it is maintained by the community,
11-
(there are no dedicated maintainers) meaning that we mostly rely on people who report bugs to make PRs for the fixes.
12-
We are however happy to help review and land your PRs, and publish new versions with the fixes.
13-
In order to prevent drowning in unactionable bugs, maintainers will ruthlessly close any bugs that are not clearly defined.
14-
- In particular, if you are having general issues with your particular build environment,
15-
please start a conversation in [Discussions](https://github.com/visgl/deck.gl/discussions)
16-
rather than opening issues.
17-
- Also check [existing issues](https://github.com/visgl/deck.gl-community/issues)to avoid filing duplicate bugs.
18-
You may find answers faster by searching in [the documentation](https://deck.gl-community/search).
10+
You may find answers faster by searching in [the documentation](https://deck.gl/search) and [existing issues](https://github.com/visgl/deck.gl/issues).
11+
If you are unsure whether it is a bug in your own implementation or the library itself, consider starting a conversation in [Discussions](https://github.com/visgl/deck.gl/discussions) instead.
12+
- type: textarea
13+
attributes:
14+
label: Description
15+
description: What you're experiencing.
16+
validations:
17+
required: true
18+
- type: checkboxes
19+
id: flavor
20+
attributes:
21+
label: Flavors
22+
description: Are you using one of the following platform-specific APIs?
23+
options:
24+
- label: Script tag
25+
- label: React
26+
- label: Python/Jupyter notebook
27+
- label: MapboxOverlay
28+
- label: GoogleMapsOverlay
29+
- label: CartoLayer
30+
- label: ArcGIS
31+
- type: textarea
32+
attributes:
33+
label: Expected Behavior
34+
description: What you expect to see.
35+
validations:
36+
required: false
37+
- type: textarea
38+
attributes:
39+
label: Steps to Reproduce
40+
description: |
41+
Providing the following could help us resolve this issue faster:
42+
- A Codepen that reproduces the behavior. A good starting point is the "edit in CodePen" links in the layer documentations.
43+
- A sample of your dataset
44+
validations:
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: Environment
49+
description: |
50+
Example:
51+
- **Framework version**: deck.gl@8.9.0
52+
- **Browser**: Chrome 110.0
53+
- **OS**: iOS 16.3
54+
value: |
55+
- Framework version:
56+
- Browser:
57+
- OS:
58+
validations:
59+
required: true
60+
- type: textarea
61+
attributes:
62+
label: Logs
63+
description: Check the browser console for any relevant errors or warnings.
64+
validations:
65+
required: false

0 commit comments

Comments
 (0)