From 3e14409abf047591cfa322f640cb9327a4523dd0 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:50:11 +0200 Subject: [PATCH 1/8] misc: Use form template for bug reports --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 71 ------------------- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 99 +++++++++++++++++++++++++++ 2 files changed, 99 insertions(+), 71 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yml diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md deleted file mode 100644 index 82f416307d..0000000000 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -name: 🐞 Bug Report -about: Tell us about something that's not working the way we (probably) intend. -labels: ["Platform: React-Native", "Type: 🪲 Bug"] ---- - -**OS:** -- [ ] Windows -- [ ] MacOS -- [ ] Linux - -**Platform:** -- [ ] iOS -- [ ] Android - -**SDK:** -- [ ] `@sentry/react-native` (>= 1.0.0) -- [ ] `react-native-sentry` (<= 0.43.2) - -**SDK version:** 0.0.0 - -**`react-native` version:** 0.0.0 - -**Are you using Expo?** -- [ ] Yes -- [ ] No - -**Are you using sentry.io or on-premise?** -- [ ] sentry.io (SaaS) -- [ ] on-premise - -**If you are using sentry.io, please post a link to your issue so we can take a look:** - -[Link to issue] - -**Configuration:** - -(`@sentry/react-native`) -``` -Sentry.init({ - dsn: 'https://...@sentry.io/...' - // other options -}); -``` - -or - -(`react-native-sentry`) -``` -Sentry.config( - 'https://...@sentry.io/...' - // other options - ).install(); -``` - ---- -**I have the following issue:** - -[Description] - -**Steps to reproduce:** -- Step 1 -- Step 2 - -**Actual result:** - -[Actual result] - -**Expected result:** - -[Expected result] diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 0000000000..623ee69464 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,99 @@ +name: "🐞 Bug Report" +description: "Tell us about something that's not working the way we (probably) intend." +labels: ["Platform: React-Native", "Type: 🪲 Bug"] +body: + - type: dropdown + id: environment + attributes: + label: Environment + description: "What libraries do you use?" + multiple: true + options: + - "React Native without Frameworks" + - "React Navigation" + - "Hermes" + - "RN New Architecture" + - "Expo Application Services (EAS)" + - "Expo (mobile only)" + - "Expo Web" + - "Expo Router" + - "React Native Web" + - "React Native Navigation by Wix" + - "sentry.io SaS" + - "Self-Hosted Sentry" + validations: + required: true + + - type: input + id: version + attributes: + label: Version + description: Which version of `@sentry/react-native` do you use? + placeholder: 5.33.1 ← should look like this + validations: + required: true + + - type: textarea + id: doctor + attributes: + label: Doctor + description: "Output of the command `npx react-native@latest info` or manully describe your development environment?" + validations: + required: true + placeholder: |- + info Fetching system and libraries information... + OS: OS version + Node: Your version + Yarn: Yarn version + Expo SDK: Expo SDK version + react: React version + react-native: React Native version + hermesEnabled: bool + newArchEnabled: bool + + - type: textarea + id: init + attributes: + label: Sentry.init() + description: "Code snipped of Sentry initialization from your application." + validations: + required: true + placeholder: |- + Sentry.init({ + dsn: 'https://...@sentry.io/...' + // other options + }); + + - type: textarea + id: repro + attributes: + label: Steps to Reproduce + description: "How can we see what you're seeing? Specific is terrific." + validations: + required: true + placeholder: |- + 1. Build Android using `npx react-native run-android --mode Debug` + 2. Start Metro Dev server using `npx react-native start` + 3. Click on button executing `Sentry.capture(new Error("This is not captured :("))` + + - type: textarea + id: expected + attributes: + label: Expected Result + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Result + description: JS Console? iOS Console? Logcat? Screenshots? Yes, please. + validations: + required: true + + - type: markdown + attributes: + value: |- + + ## Thank you 🙏 + Check our [triage docs](https://open.sentry.io/triage/) for what to expect next. From 85e4dfdea9ac744fb68a7e82800c6e206995f957 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:53:48 +0200 Subject: [PATCH 2/8] Update BUG_REPORT.yml --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 30 +++++++++++++-------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 623ee69464..e7c209a1f7 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -4,6 +4,8 @@ labels: ["Platform: React-Native", "Type: 🪲 Bug"] body: - type: dropdown id: environment + validations: + required: true attributes: label: Environment description: "What libraries do you use?" @@ -21,25 +23,23 @@ body: - "React Native Navigation by Wix" - "sentry.io SaS" - "Self-Hosted Sentry" - validations: - required: true - type: input id: version + validations: + required: true attributes: label: Version description: Which version of `@sentry/react-native` do you use? placeholder: 5.33.1 ← should look like this - validations: - required: true - type: textarea id: doctor + validations: + required: true attributes: label: Doctor description: "Output of the command `npx react-native@latest info` or manully describe your development environment?" - validations: - required: true placeholder: |- info Fetching system and libraries information... OS: OS version @@ -53,11 +53,11 @@ body: - type: textarea id: init + validations: + required: true attributes: label: Sentry.init() description: "Code snipped of Sentry initialization from your application." - validations: - required: true placeholder: |- Sentry.init({ dsn: 'https://...@sentry.io/...' @@ -66,11 +66,11 @@ body: - type: textarea id: repro + validations: + required: true attributes: label: Steps to Reproduce description: "How can we see what you're seeing? Specific is terrific." - validations: - required: true placeholder: |- 1. Build Android using `npx react-native run-android --mode Debug` 2. Start Metro Dev server using `npx react-native start` @@ -78,18 +78,18 @@ body: - type: textarea id: expected - attributes: - label: Expected Result validations: required: true + attributes: + label: Expected Result - type: textarea id: actual - attributes: - label: Actual Result - description: JS Console? iOS Console? Logcat? Screenshots? Yes, please. validations: required: true + attributes: + label: Actual Result + description: "JS Console? iOS Console? Logcat? Screenshots? Yes, please." - type: markdown attributes: From 074df44ec56449dff70b2daa62d92eed13a70fdf Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Fri, 11 Oct 2024 17:01:12 +0200 Subject: [PATCH 3/8] Update BUG_REPORT.yml --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index e7c209a1f7..449d37c6a1 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -7,8 +7,8 @@ body: validations: required: true attributes: - label: Environment - description: "What libraries do you use?" + label: What React Native libraries do you use? + description: "Select all options that describe your application." multiple: true options: - "React Native without Frameworks" @@ -29,8 +29,8 @@ body: validations: required: true attributes: - label: Version - description: Which version of `@sentry/react-native` do you use? + label: `@sentry/react-native` Version + description: If the issue started after the SDK upgrade, please input both old and new versions. placeholder: 5.33.1 ← should look like this - type: textarea @@ -38,7 +38,7 @@ body: validations: required: true attributes: - label: Doctor + label: How does your development environment look like? description: "Output of the command `npx react-native@latest info` or manully describe your development environment?" placeholder: |- info Fetching system and libraries information... From fefd938ce30a9c7111ad31080ae6962dc7e76e08 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Fri, 11 Oct 2024 17:02:17 +0200 Subject: [PATCH 4/8] Update BUG_REPORT.yml --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 449d37c6a1..5b5efbd13f 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -7,7 +7,7 @@ body: validations: required: true attributes: - label: What React Native libraries do you use? + label: "What React Native libraries do you use?" description: "Select all options that describe your application." multiple: true options: @@ -29,16 +29,16 @@ body: validations: required: true attributes: - label: `@sentry/react-native` Version - description: If the issue started after the SDK upgrade, please input both old and new versions. - placeholder: 5.33.1 ← should look like this + label: "`@sentry/react-native` Version" + description: "If the issue started after the SDK upgrade, please input both old and new versions." + placeholder: "5.33.1 ← should look like this" - type: textarea id: doctor validations: required: true attributes: - label: How does your development environment look like? + label: "How does your development environment look like?" description: "Output of the command `npx react-native@latest info` or manully describe your development environment?" placeholder: |- info Fetching system and libraries information... @@ -56,7 +56,7 @@ body: validations: required: true attributes: - label: Sentry.init() + label: "Sentry.init()" description: "Code snipped of Sentry initialization from your application." placeholder: |- Sentry.init({ @@ -69,7 +69,7 @@ body: validations: required: true attributes: - label: Steps to Reproduce + label: "Steps to Reproduce" description: "How can we see what you're seeing? Specific is terrific." placeholder: |- 1. Build Android using `npx react-native run-android --mode Debug` @@ -81,14 +81,14 @@ body: validations: required: true attributes: - label: Expected Result + label: "Expected Result" - type: textarea id: actual validations: required: true attributes: - label: Actual Result + label: "Actual Result" description: "JS Console? iOS Console? Logcat? Screenshots? Yes, please." - type: markdown From f056e1265e27abd2b36da29d78959d59d4bf1d18 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Fri, 11 Oct 2024 17:03:31 +0200 Subject: [PATCH 5/8] Update BUG_REPORT.yml --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 5b5efbd13f..f8114c17cb 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -29,7 +29,7 @@ body: validations: required: true attributes: - label: "`@sentry/react-native` Version" + label: "@sentry/react-native SDK Version" description: "If the issue started after the SDK upgrade, please input both old and new versions." placeholder: "5.33.1 ← should look like this" From 746e97cc5c15cf74ff4ef094a0ed84c236e9da74 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Mon, 14 Oct 2024 13:00:50 +0200 Subject: [PATCH 6/8] Update BUG_REPORT.yml --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index f8114c17cb..208fe2ce1c 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -24,6 +24,17 @@ body: - "sentry.io SaS" - "Self-Hosted Sentry" + - type: dropdown + id: environment + validations: + required: true + attributes: + label: "Are you using sentry.io or on-premise?" + description: "Select exactly one option." + options: + - "sentry.io (SaS)" + - "on-premise (Self-Hosted)" + - type: input id: version validations: From bfe96a69fa7fd27b83000cce524f6a939655cfe6 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Mon, 14 Oct 2024 13:01:13 +0200 Subject: [PATCH 7/8] Update BUG_REPORT.yml --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 208fe2ce1c..08a563c0db 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -25,7 +25,7 @@ body: - "Self-Hosted Sentry" - type: dropdown - id: environment + id: sentry validations: required: true attributes: From 653bd49c9d0952417f055c667c78cc0659f469bb Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Mon, 14 Oct 2024 13:01:34 +0200 Subject: [PATCH 8/8] Update BUG_REPORT.yml --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 08a563c0db..d214037c95 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -21,8 +21,6 @@ body: - "Expo Router" - "React Native Web" - "React Native Navigation by Wix" - - "sentry.io SaS" - - "Self-Hosted Sentry" - type: dropdown id: sentry