Skip to content
Source
Sign inSign up
TanStack/devtools
Open History to see the last commit

bug_report.yml

100 lines5.3 KB

1name: 'πŸ› Bug report'
2description: Report a reproducible bug or regression
3body:
4 - type: markdown
5 attributes:
6 value: |
7 Thank you for reporting an issue :pray:.
8​
9 This issue tracker is for reporting reproducible bugs or regression's found in [react-devtools](https://github.com/tanstack/devtools)
10 If you have a question about how to achieve or implement something and are struggling, please post a question
11 inside of react-devtools's [Discussions tab](https://github.com/tanstack/devtools/discussions) instead of filing an issue.
12​
13 Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
14 - TanStack Devtools's [Discussions tab](https://github.com/tanstack/devtools/discussions)
15 - TanStack Devtools's [Open Issues](https://github.com/tanstack/devtools/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
16 - TanStack Devtools's [Closed Issues](https://github.com/tanstack/devtools/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
17​
18 The more information you fill in, the better the community can help you.
19​
20 - type: input
21 id: tanstack-devtools-version
22 attributes:
23 label: TanStack Devtools version
24 description: |
25 - Please let us know the exact version of the TanStack Devtools framework adapter that you were using when the issue occurred. If you are using an older version, check to see if your bug has already been solved in the latest version. Please don't just put in "latest", as this is subject to change.
26 - The latest "devtools" version is <img alt="" src="https://badgen.net/npm/v/@tanstack/react-devtools" />
27 placeholder: |
28 e.g. v8.11.6
29 validations:
30 required: true
31​
32 - type: input
33 id: framework-library-version
34 attributes:
35 label: Framework/Library version
36 description: Which framework and what version of that framework are you using?
37 placeholder: |
38 e.g. React v17.0.2
39 validations:
40 required: true
41​
42 - type: textarea
43 id: description
44 attributes:
45 label: Describe the bug and the steps to reproduce it
46 description: Provide a clear and concise description of the challenge you are running into, and the steps we should take to try to reproduce your bug.
47 validations:
48 required: true
49​
50 - type: input
51 id: link
52 attributes:
53 label: Your Minimal, Reproducible Example - (Sandbox Highly Recommended)
54 description: |
55 Please add a link to a minimal reproduction.
56 Note:
57 - Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than React.
58 - To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/).
59 - Please make sure the example is complete and runnable without prior dependencies and free of unnecessary abstractions
60 - Feel free to fork any of the official CodeSandbox examples to reproduce your issue: https://github.com/tanstack/devtools/tree/main/examples/
61 - For React Native, you can use: https://snack.expo.dev/
62 - For TypeScript related issues only, a TypeScript Playground link might be sufficient: https://www.typescriptlang.org/play
63 - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
64 placeholder: |
65 e.g. Code Sandbox, Stackblitz, TypeScript Playground, etc.
66 validations:
67 required: true
68​
69 - type: textarea
70 id: screenshots_or_videos
71 attributes:
72 label: Screenshots or Videos (Optional)
73 description: |
74 If applicable, add screenshots or a video to help explain your problem.
75 For more information on the supported file image/file types and the file size limits, please refer
76 to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
77 placeholder: |
78 You can drag your video or image files inside of this editor ↓
79​
80 - type: dropdown
81 attributes:
82 options:
83 - No, because I do not know how
84 - No, because I do not have time to dig into it
85 - Maybe, I'll investigate and start debugging
86 - Yes, I think I know how to fix it and will discuss it in the comments of this issue
87 - Yes, I am also opening a PR that solves the problem along side this issue
88 label: Do you intend to try to help solve this bug with your own PR?
89 description: |
90 If you think you know the cause of the problem, the fastest way to get it fixed is to suggest a fix, or fix it yourself! However, it is ok if you cannot solve this yourself and are just wanting help.
91 - type: checkboxes
92 id: agrees-to-terms
93 attributes:
94 label: Terms & Code of Conduct
95 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.
96 options:
97 - label: I agree to follow this project's Code of Conduct
98 required: true
99 - 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.
100 required: true