Skip to content

Commit 87a2480

Browse files
committed
feat: issue templates
1 parent 2a3a1fe commit 87a2480

7 files changed

Lines changed: 201 additions & 77 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 45 deletions
This file was deleted.
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Bug report
2+
description: Report a bug in react-tooltip
3+
title: "[BUG] "
4+
labels:
5+
- Bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Check the troubleshooting page before opening an issue:
11+
https://react-tooltip.com/docs/troubleshooting
12+
- type: textarea
13+
id: bug-description
14+
attributes:
15+
label: Bug description
16+
description: Describe the problem clearly and directly.
17+
placeholder: The tooltip stays open after the anchor is removed...
18+
validations:
19+
required: true
20+
- type: input
21+
id: package-version
22+
attributes:
23+
label: Package version
24+
placeholder: 6.0.0
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: reproduce
29+
attributes:
30+
label: To reproduce
31+
description: List the steps needed to reproduce the issue.
32+
placeholder: |
33+
1. Render a tooltip with...
34+
2. Hover the anchor...
35+
3. Notice...
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: expected
40+
attributes:
41+
label: Expected behavior
42+
placeholder: The tooltip should close after...
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: actual
47+
attributes:
48+
label: Actual behavior
49+
placeholder: The tooltip closes immediately when...
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: environment
54+
attributes:
55+
label: Environment
56+
description: Include only the values that apply.
57+
render: markdown
58+
value: |
59+
- OS:
60+
- Browser:
61+
- Browser version:
62+
- React version:
63+
- Framework:
64+
- Rendering mode:
65+
validations:
66+
required: false
67+
- type: textarea
68+
id: code
69+
attributes:
70+
label: Reproduction snippet or repository
71+
description: Share a minimal code sample, StackBlitz, CodeSandbox, or repository link when possible.
72+
render: shell
73+
validations:
74+
required: false
75+
- type: textarea
76+
id: screenshots
77+
attributes:
78+
label: Screenshots or recordings
79+
description: Paste screenshots, recordings, or any visual context that helps explain the issue.
80+
validations:
81+
required: false
82+
- type: textarea
83+
id: additional-context
84+
attributes:
85+
label: Additional context
86+
placeholder: Anything else that is relevant to the bug.
87+
validations:
88+
required: false
89+
- type: checkboxes
90+
id: checks
91+
attributes:
92+
label: Checks
93+
options:
94+
- label: I searched existing issues and did not find an open match.
95+
required: true
96+
- label: I checked the troubleshooting page before opening this issue.
97+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Troubleshooting guide
4+
url: https://react-tooltip.com/docs/troubleshooting
5+
about: Check the troubleshooting guide before opening a bug report.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Feature request
2+
description: Suggest an improvement or new capability
3+
title: "[FEAT REQ] "
4+
labels:
5+
- Feature Request
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: Problem to solve
11+
description: Describe the limitation, friction, or missing capability.
12+
placeholder: I need a way to...
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: proposed-solution
17+
attributes:
18+
label: Proposed solution
19+
description: Describe the API, behavior, or developer experience you want.
20+
placeholder: Add a prop that...
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Alternatives considered
27+
description: Describe workarounds or alternative designs you considered.
28+
placeholder: I tried...
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: example
33+
attributes:
34+
label: Example usage
35+
description: Show what the feature would look like in real code if you can.
36+
render: tsx
37+
validations:
38+
required: false
39+
- type: textarea
40+
id: additional-context
41+
attributes:
42+
label: Additional context
43+
description: Add screenshots, references, prior art, or anything else that helps frame the request.
44+
validations:
45+
required: false
46+
- type: checkboxes
47+
id: checks
48+
attributes:
49+
label: Checks
50+
options:
51+
- label: I searched existing issues and did not find an open match.
52+
required: true

.github/ISSUE_TEMPLATE/question.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Question
2+
description: Ask a usage or integration question
3+
title: "[QUESTION] "
4+
labels:
5+
- Question
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this form for usage and integration questions.
11+
12+
If you are reporting a bug or requesting a feature, use the matching template instead.
13+
- type: textarea
14+
id: question
15+
attributes:
16+
label: Question
17+
description: Describe what you are trying to do and what is unclear.
18+
placeholder: How can I...
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: current-setup
23+
attributes:
24+
label: Current setup
25+
description: Share the relevant environment or integration details.
26+
render: markdown
27+
value: |
28+
- react-tooltip version:
29+
- React version:
30+
- Framework:
31+
validations:
32+
required: false
33+
- type: textarea
34+
id: code
35+
attributes:
36+
label: Relevant code
37+
description: Paste the smallest example that shows your current approach.
38+
render: tsx
39+
validations:
40+
required: false
41+
- type: textarea
42+
id: additional-context
43+
attributes:
44+
label: Additional context
45+
description: Add any extra details that would help answer the question.
46+
validations:
47+
required: false

0 commit comments

Comments
 (0)