Skip to content

Commit 46f8473

Browse files
committed
Issue template refinement
1 parent 163b544 commit 46f8473

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,41 @@
11
name: Bug Report
2-
description: Something does not work as expected
2+
description:
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-
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.
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).
19+
- type: checkboxes
20+
id: flavor
21+
attributes:
22+
label: Module
23+
description: First, we need to understand which deck.gl-community module you are using.
24+
options:
25+
- label: deck.gl-community/arrow-layers
26+
- label: deck.gl-community/bing-maps
27+
- label: deck.gl-community/editable-layers
28+
- label: deck.gl-community/experimental
29+
- label: deck.gl-community/graph-layers
30+
- label: deck.gl-community/layers
31+
- label: deck.gl-community/react
32+
- label: deck.gl-community/react-graph-layer
1233
- type: textarea
1334
attributes:
1435
label: Description
1536
description: What you're experiencing.
1637
validations:
1738
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
3139
- type: textarea
3240
attributes:
3341
label: Expected Behavior
@@ -38,7 +46,7 @@ body:
3846
attributes:
3947
label: Steps to Reproduce
4048
description: |
41-
Providing the following could help us resolve this issue faster:
49+
Providing the following could help us understand this issue faster:
4250
- A Codepen that reproduces the behavior. A good starting point is the "edit in CodePen" links in the layer documentations.
4351
- A sample of your dataset
4452
validations:
@@ -48,9 +56,9 @@ body:
4856
label: Environment
4957
description: |
5058
Example:
51-
- **Framework version**: deck.gl@8.9.0
52-
- **Browser**: Chrome 110.0
53-
- **OS**: iOS 16.3
59+
- **Framework version**: @9.0.0
60+
- **Browser**: Chrome 120.0
61+
- **OS**: Windows 11
5462
value: |
5563
- Framework version:
5664
- Browser:

0 commit comments

Comments
 (0)