Skip to content

Commit d12d0cf

Browse files
authored
chore: issue template (TanStack#3154)
1 parent f4eb194 commit d12d0cf

File tree

1 file changed

+36
-11
lines changed

1 file changed

+36
-11
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.yml

+36-11
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ body:
66
value: |
77
Thank you for reporting an issue :pray:.
88
9-
This issue tracker is for reporting reproducible bugs or regression's found in react-query (https://github.com/tannerlinsley/react-query)
9+
This issue tracker is for reporting reproducible bugs or regression's found in [react-query](https://github.com/tannerlinsley/react-query)
1010
If you have a question about how to achieve something and are struggling, please post a question
11-
inside of react-query's Discussion's tab: https://github.com/tannerlinsley/react-query/discussions
11+
inside of react-query's [Discussions tab](https://github.com/tannerlinsley/react-query/discussions)
1212
1313
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
14-
- react-query's Discussion's tab: https://github.com/tannerlinsley/react-query/discussions
15-
- react-query's Issue's tab: https://github.com/tannerlinsley/react-query/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
16-
- react-query's Closed issues tab: https://github.com/tannerlinsley/react-query/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
14+
- react-query's [Discussions tab](https://github.com/tannerlinsley/react-query/discussions)
15+
- react-query's [Open Issues](https://github.com/tannerlinsley/react-query/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
16+
- react-query's [Closed Issues](https://github.com/tannerlinsley/react-query/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
1717
1818
The more information you fill in, the better the community can help you.
1919
- type: textarea
@@ -26,15 +26,20 @@ body:
2626
- type: input
2727
id: link
2828
attributes:
29-
label: Your Example Website or App
29+
label: Your minimal, reproducible example
3030
description: |
31-
Which website or app were you using when the bug happened?
31+
Please add a link to a minimal reproduction.
3232
Note:
33-
- Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than React.
34-
- To create a shareable code example you can use Stackblitz (https://stackblitz.com/) or CodeSandbox (https://codesandbox.io/s/new). Please no localhost URLs.
33+
- Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than React.
34+
- To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/).
35+
- Please make sure the example is complete and runnable - e.g. avoid localhost URLs.
36+
- To stub out real api requests - Promise.resolve and Promise.reject are good options for easy reproduction
37+
- Feel free to fork any of the official CodeSandbox examples to reproduce your issue: https://react-query.tanstack.com/examples/simple
38+
- For React Native, you can use: https://snack.expo.dev/
39+
- For TypeScript related issues only, a TypeScript Playground link might be sufficient: https://www.typescriptlang.org/play
3540
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
3641
placeholder: |
37-
e.g. Stackblitz, Code Sandbox app url
42+
e.g. Code Sandbox, Stackblitz, Expo Snack or TypeScript playground
3843
validations:
3944
required: true
4045
- type: textarea
@@ -82,12 +87,32 @@ body:
8287
id: platform
8388
attributes:
8489
label: Platform
85-
value: |
90+
description: |
91+
Please let us know which Operting System, Browser and Browser version you were using when the issue occurred.
92+
placeholder: |
8693
- OS: [e.g. macOS, Windows, Linux, iOS, Android]
8794
- Browser: [e.g. Chrome, Safari, Firefox, React Native]
8895
- Version: [e.g. 91.1]
8996
validations:
9097
required: true
98+
- type: input
99+
id: rq-version
100+
attributes:
101+
label: react-query version
102+
description: |
103+
Please let us know the exact version of react-query you were using when the issue occurred. Please don't just put in "latest", as this is subject to change.
104+
placeholder: |
105+
e.g. v3.30.1
106+
validations:
107+
required: true
108+
- type: input
109+
id: ts-version
110+
attributes:
111+
label: TypeScript version
112+
description: |
113+
If you are using TypeScript, please let us know the exact version of TypeScript you were using when the issue occurred.
114+
placeholder: |
115+
e.g. v4.5.4
91116
- type: textarea
92117
id: additional
93118
attributes:

0 commit comments

Comments
 (0)