Skip to content

Commit 6f6449f

Browse files
committed
improved issue reporting guide
1 parent 2ea4030 commit 6f6449f

File tree

4 files changed

+85
-1
lines changed

4 files changed

+85
-1
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: lukasbach
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior. Ideally this includes a sandbox link that reproduces the issue. There
14+
are some starter sandboxes provided for Headless Tree for Codesandbox or Stackblitz, that you can use
15+
to create a reproduction: https://headless-tree.lukasbach.com/examples
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem. A gif or screencast can also help understand your problem.
22+
23+
**Additional context**
24+
You can help by providing additional details that are available to you, such as
25+
26+
- Device if mobile
27+
- Operating System, Browser
28+
- Version of the Library or tool for which you report the bug
29+
30+
<!--
31+
By the way, I also have a Github Sponsor account. A small contribution can help me continue investing free time
32+
into maintaining and improving my open source work.
33+
34+
https://github.com/sponsors/lukasbach
35+
36+
I can also provide paid support or consultancy to help you with integrating my project, or to prioritize your
37+
issue. Feel free to contact me through contact@lukasbach.com, and we can find something that works for both
38+
of us :)
39+
-->

.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: Discord Chat
4+
url: https://discord.gg/KuZ6EezzVw
5+
about: An official discord server to discuss issues and features
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: lukasbach
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.
20+
21+
<!--
22+
By the way, I also have a Github Sponsor account. A small contribution can help me continue investing free time
23+
into maintaining and improving my open source work.
24+
25+
https://github.com/sponsors/lukasbach
26+
27+
I can also provide paid support or consultency to help you with integrating my project, or to prioritize your
28+
issue. Feel free to contact me through contact@lukasbach.com, and we can find something that works for both
29+
of us :)
30+
-->

packages/docs/docs/getstarted.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ if you want to experiment with the latest features.
2828

2929
:::tip[Headless Tree is available!]
3030

31-
Headless Tree is now available as Beta! If the library provides you with a benefit, leaving [a star
31+
Headless Tree is now available as Beta! If the library provides value to you, leaving [a star
3232
on Github](https://github.com/lukasbach/headless-tree) would help a lot with the visibility of the project.
3333

3434
:::
@@ -149,3 +149,13 @@ a more complex payload type, and how to use the `getItemName` and `isItemFolder`
149149
display name and folder status of an item.
150150

151151
<DemoBox stories={["react-general-item-data-objects--item-data-objects"]} />
152+
153+
:::tip
154+
155+
If the library provides value to you, leaving [a star
156+
on Github](https://github.com/lukasbach/headless-tree) would help a lot with the visibility of the project.
157+
If you encounter any bugs or issues, or have feedback about Headless Tree, please don't hesitate to
158+
open [an issue on Github](https://github.com/lukasbach/headless-tree/issues/new/choose), or get involved
159+
in the [discussion on Discord](https://discord.gg/KuZ6EezzVw).
160+
161+
:::

0 commit comments

Comments
 (0)