Skip to content

Commit 2de2c81

Browse files
chore: add issue templates
1 parent 4b91665 commit 2de2c81

File tree

3 files changed

+107
-0
lines changed

3 files changed

+107
-0
lines changed
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Bug report
2+
description: Create a bug report to help us improve.
3+
labels:
4+
- BUG
5+
title: '[BUG]'
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Make sure you have updated to the latest version of the module
10+
description: This may be a beta version of the module, or may require you to update your companion.
11+
options:
12+
- label: I have checked this on the latest version of the module
13+
required: true
14+
- type: checkboxes
15+
attributes:
16+
label: Is there an existing issue for this?
17+
description: Please search to see if an issue already exists for the bug you encountered.
18+
options:
19+
- label: I have searched the existing issues
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Describe the bug
24+
description: A clear and concise description of what the bug is. Screenshots are always helpful to understand the problem.
25+
validations:
26+
required: false
27+
- type: textarea
28+
attributes:
29+
label: Steps To Reproduce
30+
description: Steps to reproduce the behavior.
31+
placeholder: |
32+
1. Go to '...'
33+
2. Click on '....'
34+
3. Scroll down to '....'
35+
4. See error
36+
validations:
37+
required: false
38+
- type: textarea
39+
attributes:
40+
label: Expected Behavior
41+
description: A concise description of what you expected to happen.
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Environment (please complete the following information)
47+
description: |
48+
examples:
49+
- **OS**: Windows 10
50+
- **Browser**: Chrome 94
51+
- **Companion Version**: 2.2.0-b177f8fb-3722
52+
- **Module Version**: 1.0.0
53+
- **Device Firmware/Software Version (If applicable)**: 3.0.6
54+
- **Device Model (If applicable)**: My Device PRO
55+
value: |
56+
- OS:
57+
- Browser:
58+
- Companion Version:
59+
- Module Version:
60+
- Device Firmware/Software Version (If applicable):
61+
- Device Model (If applicable):
62+
render: markdown
63+
validations:
64+
required: false
65+
- type: textarea
66+
attributes:
67+
label: Additional context
68+
description: Add any other context about the problem here.
69+
validations:
70+
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: BUG OR FEATURE REQUEST FOR COMPANION ITSELF
4+
url: https://github.com/bitfocus/companion/issues
5+
about: Report it against the companion itself, to get the relevant people notified.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature Request
2+
description: Request a new feature within this module
3+
title: '[Feature]: '
4+
labels:
5+
- enhancement
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Make sure you have updated to the latest version of the module
10+
description: This may be a beta version of the module, or may require you to update your companion.
11+
options:
12+
- label: I have checked this on the latest version of the module
13+
required: true
14+
- type: checkboxes
15+
attributes:
16+
label: Is there an existing issue for this?
17+
description: Please search to see if an issue already exists for the feature.
18+
options:
19+
- label: I have searched for similar existing issues
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Describe the feature
24+
description: A clear and concise description of what the feature does. Mocked up screenshots (no matter how rough) are always helpful in understanding.
25+
validations:
26+
required: false
27+
- type: textarea
28+
attributes:
29+
label: Usecases
30+
description: Add a couple of usecases for why this should be implemented and when/why to use it.
31+
validations:
32+
required: false

0 commit comments

Comments
 (0)