Skip to content

Commit e156f67

Browse files
committed
docs: create issue config and template
1 parent aba685e commit e156f67

File tree

2 files changed

+102
-0
lines changed

2 files changed

+102
-0
lines changed
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 an issue to make ViRe better
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
# Bug report
9+
*Thanks for taking the time to fill out this bug report and helping improve ViRe!*
10+
Please try to fill out all fields to the best of your ability.
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the bug
15+
description: Clearly and concisely write up what is the problem.
16+
placeholder: Enter your description here.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: reproduction-steps
21+
attributes:
22+
label: To Reproduce
23+
description: Steps to reproduce the behavior.
24+
placeholder: |
25+
1. Hover the '...' menu option
26+
2. Click '....' button
27+
3. Scroll down to '....'
28+
4. See error
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: expected-behaviour
33+
attributes:
34+
label: Expected behavior
35+
description: What you expected to happen instead?
36+
placeholder: Type here.
37+
validations:
38+
required: false
39+
- type: textarea
40+
id: screenshots
41+
attributes:
42+
label: Screenshots
43+
description: If applicable, add screenshots to help explain your problem.
44+
placeholder: Upload your screenshots here. You can paste them or click on "Attach files".
45+
validations:
46+
required: false
47+
- type: textarea
48+
id: troubleshooting
49+
attributes:
50+
label: Troubleshooting
51+
description: Which steps, if any, did you take to troubleshoot?
52+
placeholder: |
53+
1. Tried it on version '...'
54+
2. Changed the '....' SteamVR setting
55+
validations:
56+
required: false
57+
- type: input
58+
id: version
59+
attributes:
60+
label: Version
61+
description: Get the version from the settings menu (bottom right corner)
62+
placeholder: v0.12.1A
63+
validations:
64+
required: true
65+
- type: dropdown
66+
id: os
67+
attributes:
68+
label: Operating system
69+
multiple: true
70+
options:
71+
- Windows
72+
- Linux
73+
validations:
74+
required: true
75+
- type: input
76+
id: headset
77+
attributes:
78+
label: VR headset
79+
description: Which headset did you use? You can specify multiple
80+
placeholder: HTC Vive
81+
validations:
82+
required: true
83+
- type: checkboxes
84+
id: discord
85+
attributes:
86+
label: Did you reach out to us on Discord?
87+
description: We want to know, so that we can match up your report there
88+
options:
89+
- label: Reported on Discord
90+
required: false
91+
- type: textarea
92+
id: additional
93+
attributes:
94+
label: Additional info
95+
description: Is there anything else we should know?
96+
validations:
97+
required: false

.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 contact
4+
url: https://discord.gg/8yzVHS7XUF
5+
about: Got a feature suggestion or question? Drop us a line here!

0 commit comments

Comments
 (0)