8000 fix(dev): Clarify issue template framework field (#5480) · pulse00/sentry-javascript@7d44301 · GitHub
[go: up one dir, main page]

Skip to content

Commit 7d44301

Browse files
authored
fix(dev): Clarify issue template framework field (getsentry#5480)
In our bug template, we ask users for their SDK version and, if they're using a framework SDK (react, etc), the version of the framework. Users often misunderstand, however, and just provide the SDK version twice. This aims to clarify the distinction, by making three changes: - Adding clarifying language to the Framework Version field description. - Changing the placeholder example for the field to include the name of the framework, and a recent IRL version. - Changing the placeholder example for the SDK field to be the current version, to further emphasize which one is which. It also fixes two schema errors highlighted by the linter.
1 parent b524d8c commit 7d44301

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: 🐞 Bug Report
22
description: Tell us about something that's not working the way we (probably) intend.
3-
labels: "Type: Bug"
3+
labels: ["Type: Bug"]
44
body:
55
- type: checkboxes
66
attributes:
@@ -45,15 +45,15 @@ body:
4545
attributes:
4646
label: SDK Version
4747
description: What version of the SDK are you using?
48-
placeholder: ex. 1.5.2
48+
placeholder: ex. 7.8.0
4949
validations:
5050
required: true
5151
- type: input
5252
id: framework-version
5353
attributes:
5454
label: Framework Version
55-
description: If you're using one of our framework-specific SDKs (`@sentry/react`, for example), what version of the framework are you using?
56-
placeholder: ex. 1.5.2
55+
description: If you're using one of our framework-specific SDKs (`@sentry/react`, for example), what version of the _framework_ (not SDK) are you using?
56+
placeholder: ex. React 17.0.0
5757
- type: input
5858
id: link-to-sentry
5959
attributes:
@@ -88,5 +88,3 @@ body:
8888
attributes:
8989
value: |-
9090
## Thanks 🙏
91-
validations:
92-
required: false

0 commit comments

Comments
 (0)
0