diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md deleted file mode 100644 index b44814d1..00000000 --- a/.github/ISSUE_TEMPLATE/blank-issue.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: I have a problem with rive-nitro-react-native -about: Tell us what's wrong -title: '' -labels: '' -assignees: '' - ---- - - - -### Description - - -### Provide a Repro - - -#### Source `.riv`/`.rev` file - - -### Expected behavior - - -#### Screenshots - - -### Device & Versions (please complete the following information) -- Device: [e.g. Android Emulator, iOS Simulator] -- OS: [e.g. Android SDK API Level 30, iOS 14.5] -- React Native Version: [Check your package.json or run `npx react-native info` e.g.: `0.79.2`] -- Expo Version (if applicable): [Check your package.json or run `npx expo-env-info | grep 'expo:'` e.g.: `~54.0.0`] -- `@rive-app/react-native` Version: [Check your package.json e.g.: `0.1.0`] - -#### Additional context - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index dc82d4ab..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,68 +0,0 @@ -name: 🐛 Bug report -description: Report a reproducible bug or regression in this library. -labels: [bug] -body: - - type: markdown - attributes: - value: | - # Bug report - - 👋 Hi! - - **Please fill the following carefully before opening a new issue ❗** - *(Your issue may be closed if it doesn't provide the required pieces of information)* - - type: checkboxes - attributes: - label: Before submitting a new issue - description: Please perform simple checks first. - options: - - label: I tested using the latest version of the library, as the bug might be already fixed. - required: true - - label: I tested using a [supported version](https://github.com/reactwg/react-native-releases/blob/main/docs/support.md) of react native. - required: true - - label: I checked for possible duplicate issues, with possible answers. - required: true - - type: textarea - id: summary - attributes: - label: Bug summary - description: | - Provide a clear and concise description of what the bug is. - If needed, you can also provide other samples: error messages / stack traces, screenshots, gifs, etc. - validations: - required: true - - type: input - id: library-version - attributes: - label: Library version - description: What version of the library are you using? - placeholder: "x.x.x" - validations: - required: true - - type: textarea - id: react-native-info - attributes: - label: Environment info - description: Run `react-native info` in your terminal and paste the results here. - render: shell - validations: - required: true - - type: textarea - id: steps-to-reproduce - attributes: - label: Steps to reproduce - description: | - You must provide a clear list of steps and code to reproduce the problem. - value: | - 1. … - 2. … - validations: - required: true - - type: input - id: reproducible-example - attributes: - label: Reproducible example repository - description: Please provide a link to a repository on GitHub with a reproducible example. - render: js - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 99c013db..27187eb4 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: false contact_links: - - name: Feature Request 💡 - url: https://github.com/rive-app/rive-nitro-react-native/discussions/new?category=ideas - about: If you have a feature request, please create a new discussion on GitHub. + - name: Rive Documentation + url: https://rive.app/docs/runtimes/react-native/react-native + about: Please refer to the Rive documentation for feature use, supported versions, and troubleshooting steps before submitting an issue. - name: Discussions on GitHub 💬 url: https://github.com/rive-app/rive-nitro-react-native/discussions about: If this library works as promised but you need help, please ask questions there. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/runtime-issue-template.yml b/.github/ISSUE_TEMPLATE/runtime-issue-template.yml new file mode 100644 index 00000000..8c27f619 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/runtime-issue-template.yml @@ -0,0 +1,159 @@ +name: Problem with the Rive React Native Runtime +description: Report a bug or unexpected behavior in the Rive React Native runtime. +body: + - type: markdown + attributes: + value: | + Thanks for using Rive! Before filing an issue, please: + - Confirm if the issue is still present on the [latest version of `@rive-app/react-native`](https://www.npmjs.com/package/@rive-app/react-native) + - Check the [Rive documentation](https://rive.app/docs/runtimes/react-native/react-native) + - Search for help on the [Rive community forums](https://community.rive.app/) + - For runtime feature requests, post in [discussions](https://github.com/rive-app/rive-nitro-react-native/discussions) instead + + - type: checkboxes + id: preflight + attributes: + label: Submission checklist + options: + - label: I have confirmed the issue is present in the latest version of `@rive-app/react-native` + required: true + - label: I have searched the documentation and forums and could not find an answer + required: true + - label: I have searched existing issues and this is not a duplicate + required: true + + - type: textarea + id: description + attributes: + label: Description + description: What issue are you running into? What's your expected behavior? Include a full stack trace if one is available. + placeholder: Describe the issue you're experiencing + validations: + required: true + + - type: input + id: rive_version_working + attributes: + label: Previous working version + description: Has this ever worked before? If so, which version was it working on? + + - type: textarea + id: repro-description + attributes: + label: Reproduction steps / code + description: | + Please provide the most **minimal reproduction** you can. Paste a code snippet if the problem is small enough. Or share a link to a minimal GitHub repository that reproduces the issue. + + Alternatively, you can upload a .zip of your reproduction in the next question. + placeholder: | + ```tsx + // paste your code here + ``` + validations: + required: false + + - type: upload + id: repro-files + attributes: + label: Upload your reproduction files / stack trace + description: | + + If your reproduction is more complex, you can upload a .zip of your project. + Include a file with your stack trace if available as well if you cannot provide it above. + Please make sure to include a `README` with instructions on how to run the reproduction. + + - type: upload + id: riv_file + attributes: + label: Source `.riv` / `.rev` file + description: | + If you are able, attaching the runtime-exported `.riv` file (and ideally the source `.rev` backup) is immensely helpful for reproducing and fixing the issue quickly. + + Note: Use a ZIP archive to upload `.riv`/`.rev` files (GitHub only supports certain file types). You can also share files privately at support@rive.app. + validations: + required: false + + - type: upload + id: screenshots + attributes: + label: Screenshots / video + description: If applicable, add screenshots or a screen recording to help explain the problem. + validations: + required: false + + - type: input + id: rive_version + attributes: + label: "`@rive-app/react-native` version" + description: Which version of `@rive-app/react-native` are you using? + placeholder: "e.g. 0.4.7" + validations: + required: true + + - type: dropdown + id: platform + attributes: + label: Platform + description: Which platform(s) does this issue affect? + options: + - iOS only + - Android only + - Both iOS and Android + validations: + required: true + + - type: input + id: rn_version + attributes: + label: React Native version + placeholder: "e.g. 0.79.2" + validations: + required: true + + - type: textarea + id: rn_info + attributes: + label: React Native environment info + description: Run `npx react-native info` in your project root and paste the output here. + render: shell + validations: + required: false + + - type: dropdown + id: expo + attributes: + label: Expo setup + description: Are you using Expo? + options: + - "No — bare React Native" + - "Yes — Expo Go" + - "Yes — Expo Dev Client" + - "Yes — Expo prebuild / EAS Build" + validations: + required: true + + - type: input + id: expo_sdk + attributes: + label: Expo SDK version (if applicable) + placeholder: "e.g. 54.0.0" + + - type: input + id: ios_device + attributes: + label: iOS device & OS version (if applicable) + placeholder: "e.g. iPhone 16 Pro — iOS 18.4, iOS Simulator — iOS 17.5" + + - type: input + id: android_device + attributes: + label: Android device & OS version (if applicable) + placeholder: "e.g. Pixel 7 — Android 14, Android Emulator — API Level 34" + + - type: textarea + id: additional_context + attributes: + label: Additional context + description: Any other context about the problem (navigation library, Metro config, native module conflicts, frequency of occurrence, etc.). + validations: + required: false