Skip to content

Commit be67cc8

Browse files
author
clifford
committed
add github ISSUE_TEMPLATE files
1 parent 9feb503 commit be67cc8

File tree

2 files changed

+96
-0
lines changed

2 files changed

+96
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: '🐛 Bug report'
2+
description: Create a report to help us improve
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for reporting an issue :pray:.
8+
9+
This issue tracker is for reporting bugs found in `react-charts` (https://github.com/TanStack/react-charts).
10+
If you have a question about how to achieve something and are struggling, please post a question
11+
inside of `react-charts` Discussions tab: https://github.com/TanStack/react-charts/discussions
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+
- `react-charts` Issues tab: https://github.com/TanStack/react-charts/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
15+
- `react-charts` closed issues tab: https://github.com/TanStack/react-charts/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
16+
- `react-charts` Discussions tab: https://github.com/TanStack/react-charts/discussions
17+
18+
The more information you fill in, the better the community can help you.
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Describe the bug
23+
description: Provide a clear and concise description of the challenge you are running into.
24+
validations:
25+
required: true
26+
- type: input
27+
id: link
28+
attributes:
29+
label: Your Example Website or App
30+
description: |
31+
Which website or app were you using when the bug happened?
32+
Note:
33+
- Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `react-charts` npm package/dependency.
34+
- To create a shareable code example you can use Stackblitz (https://stackblitz.com/). Please no localhost URLs.
35+
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
36+
placeholder: |
37+
e.g. https://stackblitz.com/edit/...... OR Github Repo
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: steps
42+
attributes:
43+
label: Steps to Reproduce the Bug or Issue
44+
description: Describe the steps we have to take to reproduce the behavior.
45+
placeholder: |
46+
1. Go to '...'
47+
2. Click on '....'
48+
3. Scroll down to '....'
49+
4. See error
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: expected
54+
attributes:
55+
label: Expected behavior
56+
description: Provide a clear and concise description of what you expected to happen.
57+
placeholder: |
58+
As a user, I expected ___ behavior but i am seeing ___
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: screenshots_or_videos
63+
attributes:
64+
label: Screenshots or Videos
65+
description: |
66+
If applicable, add screenshots or a video to help explain your problem.
67+
For more information on the supported file image/file types and the file size limits, please refer
68+
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
69+
placeholder: |
70+
You can drag your video or image files inside of this editor ↓
71+
- type: textarea
72+
id: platform
73+
attributes:
74+
label: Platform
75+
value: |
76+
- OS: [e.g. macOS, Windows, Linux]
77+
- Browser: [e.g. Chrome, Safari, Firefox]
78+
- Version: [e.g. 91.1]
79+
validations:
80+
required: true
81+
- type: textarea
82+
id: additional
83+
attributes:
84+
label: Additional context
85+
description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🤔 Feature Requests & Questions
4+
url: https://github.com/TanStack/react-charts/discussions/discussions
5+
about: Please ask and answer questions here.
6+
- name: 💬 Community Chat
7+
url: https://discord.gg/mQd7egN
8+
about: A dedicated discord server hosted by Tanner Linsley
9+
- name: 💬 Tanstack Twitter
10+
url: https://twitter.com/tan_stack
11+
about: Stay up to date with new releases of our libraries

0 commit comments

Comments
 (0)