Skip to content

Commit 2095620

Browse files
JoniVRJoniVR
authored
Update issue templates with .yml format (#516)
See: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
1 parent 40d557b commit 2095620

File tree

10 files changed

+211
-133
lines changed

10 files changed

+211
-133
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: ["Type: Bug"]
4+
assignees: []
5+
body:
6+
- type: checkboxes
7+
id: checklist
8+
attributes:
9+
label: Before opening the issue, have you...?
10+
description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development.
11+
options:
12+
- label: Searched for existing issues
13+
required: true
14+
- label: Looked through [the wiki](https://github.com/MonitorControl/MonitorControl/wiki)
15+
required: true
16+
- label: Updated MonitorControl to the latest version (if applicable)
17+
required: true
18+
- type: textarea
19+
id: description
20+
validations:
21+
required: true
22+
attributes:
23+
label: Describe the bug
24+
description: A clear and concise description of what the bug is.
25+
placeholder: "Example: When enabling the Show contrast slider in menu option, the application crashes when clicking on the menu icon."
26+
- type: textarea
27+
id: reproduction
28+
validations:
29+
required: true
30+
attributes:
31+
label: Steps to reproduce
32+
description: Please provide some steps on how we can reproduce the problem. This helps us resolve it faster.
33+
placeholder: |
34+
1. Go to '...'
35+
2. Click on '....'
36+
3. Scroll down to '....'
37+
4. See error
38+
- type: textarea
39+
id: expected
40+
validations:
41+
required: true
42+
attributes:
43+
label: Expected behavior
44+
description: A clear and concise description of what you expected to happen.
45+
placeholder: "Example: The app shows a contrast slider when clicking the icon in the menu bar and does not crash."
46+
- type: textarea
47+
validations:
48+
required: false
49+
attributes:
50+
label: Anything else?
51+
description: |
52+
Screenshots? Links? References? Anything that will give us more context about the issue you are encountering!
53+
54+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
55+
- type: textarea
56+
validations:
57+
required: true
58+
attributes:
59+
label: Environment Information (please complete the following information)
60+
description: |
61+
examples:
62+
- **macOS version**: 11.4 Big Sur
63+
- **Mac model**: MacBook Pro (16-inch, 2019)
64+
- **MonitorControl version**: v2.1.0
65+
- **Monitor(s)**: LG 38GN950, LG 27UN83A
66+
- **Apple Silicon/M1 (yes or no)**: no
67+
value: |
68+
- macOS version:
69+
- Mac model:
70+
- MonitorControl version:
71+
- Monitor(s):
72+
- Apple Silicon/M1 (yes or no): no
73+
render: markdown

‎.github/ISSUE_TEMPLATE/discussion.md‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/discussion.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Discussion
2+
description: I want to discuss something that is related to this project
3+
labels: ["Type: Other"]
4+
assignees: []
5+
body:
6+
- type: checkboxes
7+
id: checklist
8+
attributes:
9+
label: Before opening the issue, have you...?
10+
description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development.
11+
options:
12+
- label: Searched for existing issues
13+
required: true
14+
- type: textarea
15+
id: discussion
16+
validations:
17+
required: true
18+
attributes:
19+
label: Discussion
20+
description: Feel free to type anything you want to discuss related to the project. Do note that we have a seperate template for questions.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["Type: Feature Request"]
4+
assignees: []
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Before opening the issue, have you...?
9+
description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development.
10+
options:
11+
- label: Searched for existing issues
12+
required: true
13+
- type: textarea
14+
validations:
15+
required: true
16+
attributes:
17+
label: Is your feature request related to a problem? Please describe
18+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
19+
- type: textarea
20+
validations:
21+
required: true
22+
attributes:
23+
label: Describe the solution you'd like
24+
description: A clear and concise description of what you want to happen.
25+
- type: textarea
26+
validations:
27+
required: true
28+
attributes:
29+
label: Describe alternatives you've considered
30+
description: A clear and concise description of any alternative solutions or features you've considered.
31+
- type: textarea
32+
validations:
33+
required: false
34+
attributes:
35+
label: Anything else?
36+
description: |
37+
Screenshots? Links? References? Anything that will give us more context about the issue you are encountering!
38+
39+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.

‎.github/ISSUE_TEMPLATE/monitor-issue.md‎

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/monitor-issue.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Monitor Issue
2+
description: MonitorControl is not working as expected on my monitor.
3+
labels: ["Type: Monitor Issue"]
4+
assignees: []
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Before opening the issue, have you...?
9+
description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development.
10+
options:
11+
- label: Searched for existing issues
12+
required: true
13+
- label: Looked through [the wiki](https://github.com/MonitorControl/MonitorControl/wiki)
14+
required: true
15+
- label: Updated MonitorControl to the latest version (if applicable)
16+
required: true
17+
- type: textarea
18+
validations:
19+
required: true
20+
attributes:
21+
label: Describe the issue
22+
description: A clear and concise description of the problem.
23+
placeholder: Volume & Brightness controls are not working on my LG 38GN950.
24+
- type: textarea
25+
validations:
26+
required: true
27+
attributes:
28+
label: Expected behavior
29+
description: A clear and concise description of what you expected to happen.
30+
- type: textarea
31+
validations:
32+
required: false
33+
attributes:
34+
label: Anything else?
35+
description: |
36+
Screenshots? Links? References? Anything that will give us more context about the issue you are encountering!
37+
38+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
39+
- type: textarea
40+
validations:
41+
required: false
42+
attributes:
43+
label: Environment Information (please complete the following information)
44+
description: |
45+
examples:
46+
- **macOS version**: 11.4 Big Sur
47+
- **Mac model**: MacBook Pro (16-inch, 2019)
48+
- **MonitorControl version**: v2.1.0
49+
- **Monitor(s)**: LG 38GN950, LG 27UN83A
50+
- **Monitor Cable(s)/Connection(s)**:
51+
  - Mac Mini -> DisplayPort 2.1 -> LG 38GN950
52+
  - Mac Mini -> Belkin Thunderbolt 3 Dock Core -> LG 27UN83A
53+
- **Apple Silicon/M1 (yes or no)**: no
54+
value: |
55+
- macOS version:
56+
- Mac model:
57+
- MonitorControl version:
58+
- Monitor(s):
59+
- Monitor Cable(s)/Connection(s):
60+
- Apple Silicon/M1 (yes or no):
61+
render: markdown

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Question
2+
description: I have a question related to this project
3+
labels: ["Type: Question"]
4+
assignees: []
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Before opening the issue, have you...?
9+
description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development.
10+
options:
11+
- label: Searched for existing issues
12+
required: true
13+
- type: textarea
14+
validations:
15+
required: true
16+
attributes:
17+
label: Question
18+
description: Ask your question, be specific. The more info you provide, the easier it will be for someone to answer!

0 commit comments

Comments
 (0)