Skip to content

Commit cff3dda

Browse files
authored
chore: add issue templates (#686)
* chore: add issue templates * chore: add remote device info
1 parent b4525b8 commit cff3dda

File tree

3 files changed

+132
-0
lines changed

3 files changed

+132
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: Bug report
3+
description: 🐛 Let us know about an unexpected error, a crash, or an unexpected behavior.
4+
type: 'Bug'
5+
labels:
6+
- 'type: bug'
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Disclaimer
11+
description: |
12+
For support questions, please use the [discussions][] or [Discord][] instead. Before
13+
opening a bug report, ensure you have read the [documentation][],
14+
[Troubleshooting][] and [Device FAQs][]. Only use bug reports for actual
15+
bugs.
16+
17+
[documentation]: https://jetkvm.com/docs
18+
[Troubleshooting]: https://jetkvm.com/docs/getting-started/troubleshooting
19+
[Device FAQs]: https://jetkvm.com/docs/getting-started/faq
20+
[discussions]: https://github.com/jetkvm/kvm/discussions
21+
[Discord]: https://jetkvm.com/discord
22+
options:
23+
- label: I have read and understood the disclaimer.
24+
required: true
25+
- type: input
26+
attributes:
27+
label: Application version
28+
description: |
29+
Provide the application version (can be found in General settings)
30+
validations:
31+
required: true
32+
- type: input
33+
attributes:
34+
label: System version
35+
description: |
36+
Provide the system version (can be found in General settings)
37+
validations:
38+
required: true
39+
- type: dropdown
40+
attributes:
41+
label: Device model
42+
description: Provide the device model
43+
options:
44+
- JetKVM
45+
- JetKVM (POE)
46+
validations:
47+
required: false
48+
- type: dropdown
49+
attributes:
50+
label: Extension model
51+
description: Provide the extension model (if the bug is related to the extension)
52+
options:
53+
- ATX Power Control
54+
- DC Power Control
55+
- Serial Console
56+
validations:
57+
required: false
58+
- type: input
59+
attributes:
60+
label: Remote device Hardware
61+
description: If the bug is related to a remote device, please provide its hardware information e.g. Raspberry Pi 5
62+
validations:
63+
required: false
64+
- type: input
65+
attributes:
66+
label: Remote device OS
67+
description: If the bug is related to a remote device, please provide its OS information as detailed as possible e.g. Debian 12.
68+
validations:
69+
required: false
70+
- type: textarea
71+
attributes:
72+
label: Bug description
73+
description: |
74+
Provide a description of the problem: steps to reproduce it, what you are expecting and what you got.
75+
validations:
76+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
blank_issues_enabled: true
2+
3+
contact_links:
4+
- name: Hardware Issues
5+
url: https://jetkvm.com/contact
6+
about: If your hardware is not powering on or is not working, please contact us.
7+
8+
- name: Discord
9+
url: https://jetkvm.com/discord
10+
about: Engage with the JetKVM team and other community members.

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Feature
2+
type: 'Feature'
3+
description: 🚀 Request a new feature.
4+
labels:
5+
- 'type: feature'
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: A note for the community
10+
value: |
11+
> [!NOTE]
12+
> Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request.
13+
validations:
14+
required: true
15+
- type: checkboxes
16+
attributes:
17+
label: Disclaimer
18+
description: |
19+
Before requesting a feature, check it does not already exist in the [documentation](https://jetkvm.com/docs) or our [roadmap](https://jetkvm.com/roadmap).
20+
You are quite welcome opening a feature request before spending time to implement it yourself.
21+
options:
22+
- label: I have read and understood the disclaimer.
23+
required: true
24+
- label: I plan to implement the feature myself.
25+
- type: dropdown
26+
attributes:
27+
label: Subsystem
28+
description: Provide the subsystem of the feature you request, you can choose multiple if you think it fits in multiple areas.
29+
options:
30+
- Hardware
31+
- Device Compatibility
32+
- Keyboard
33+
- Mouse
34+
- Power
35+
- UI: Screen
36+
- UI: Application
37+
- UI: Cloud
38+
validations:
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Feature description
43+
description: |
44+
Provide a description of the feature you request.
45+
validations:
46+
required: true

0 commit comments

Comments
 (0)