From eac4c1d254021351ffaddcc4ad2b36b9910f33cd Mon Sep 17 00:00:00 2001 From: Tanner Linsley Date: Thu, 2 Jun 2022 18:19:38 -0600 Subject: [PATCH] better github issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 131 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ 2 files changed, 139 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..8afad5a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,131 @@ +name: '🐛 Bug report' +description: Report a reproducible bug or regression +body: + - type: markdown + attributes: + value: | + Thank you for reporting an issue :pray:. + + This issue tracker is for reporting reproducible bugs or regression's found in [tanstack-virtual](https://github.com/tanstack/virtual) + If you have a question about how to achieve or implement something and are struggling, please post a question + inside of tanstack-virtual's [Discussions tab](https://github.com/tanstack/virtual/discussions) instead of filing an issue. + + Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already: + - tanstack-virtual's [Discussions tab](https://github.com/tanstack/virtual/discussions) + - tanstack-virtual's [Open Issues](https://github.com/tanstack/virtual/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) + - tanstack-virtual's [Closed Issues](https://github.com/tanstack/virtual/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed) + + The more information you fill in, the better the community can help you. + + > ⚠️⚠️⚠️ TanStack Table v8 is on the horizon with beta builds and v7 is entering + > an LTS phase and will only be receiving patch-level fixes. If you are experiencing + > issues in v7 that require minor/feature or major/breaking changes, your issue will + > be redirected to v8 or possibly even closed if the issue has already been fixed in v8. + + - type: textarea + id: description + attributes: + label: Describe the bug + description: Provide a clear and concise description of the challenge you are running into. + validations: + required: true + - type: input + id: link + attributes: + label: Your minimal, reproducible example + description: | + Please add a link to a minimal reproduction. + Note: + - Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than React. + - To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/). + - Please make sure the example is complete and runnable without prior dependencies and free of unnecessary abstractions + - Feel free to fork any of the official CodeSandbox examples to reproduce your issue: https://github.com/tanstack/virtual/tree/main/examples/ + - For React Native, you can use: https://snack.expo.dev/ + - For TypeScript related issues only, a TypeScript Playground link might be sufficient: https://www.typescriptlang.org/play + - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve. + placeholder: | + e.g. Code Sandbox, Stackblitz, Expo Snack or TypeScript playground + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Describe the steps we have to take to reproduce the behavior. + placeholder: | + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: Provide a clear and concise description of what you expected to happen. + placeholder: | + As a user, I expected **_ behavior but i am seeing _** + validations: + required: true + - type: dropdown + attributes: + options: + - Every time + - Often + - Sometimes + - Only once + label: How often does this bug happen? + description: | + Following the repro steps above, how easily are you able to reproduce this bug? + options: - Every time - Often - Sometimes - Only once + - type: textarea + id: screenshots_or_videos + attributes: + label: Screenshots or Videos + description: | + If applicable, add screenshots or a video to help explain your problem. + For more information on the supported file image/file types and the file size limits, please refer + to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files + placeholder: | + You can drag your video or image files inside of this editor ↓ + - type: textarea + id: platform + attributes: + label: Platform + description: | + Please let us know which Operting System, Browser and Browser version you were using when the issue occurred. + placeholder: | + - OS: [e.g. macOS, Windows, Linux, iOS, Android] - Browser: [e.g. Chrome, Safari, Firefox, React Native] - Version: [e.g. 91.1] + validations: + required: true + - type: input + id: library-version + attributes: + label: tanstack-virtual version + description: | + Please let us know the exact version of tanstack-virtual you were using when the issue occurred. Please don't just put in "latest", as this is subject to change. + placeholder: | + e.g. v3.30.1 + validations: + required: true + - type: input + id: ts-version + attributes: + label: TypeScript version + description: | + If you are using TypeScript, please let us know the exact version of TypeScript you were using when the issue occurred. + placeholder: | + e.g. v4.5.4 + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. + - type: checkboxes + id: agrees-to-terms + attributes: + label: Terms & Code of Conduct + description: By submitting this issue, you agree to follow our Code of Conduct and can verify that you have followed the requirements outlined above to the best of your ability. + options: + - label: I agree to follow this project's Code of Conduct + required: true + - label: I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ce23f2f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Feature Requests & Questions + url: https://github.com/tanstack/virtual/discussions + about: Please ask and answer questions here. + - name: Community Chat + url: https://discord.gg/mQd7egN + about: A dedicated discord server hosted by TanStack