Skip to content

Commit 9c9a535

Browse files
khasselkhassel
committed
Use different issue templates (#3695)
This PR will introduce different issue templates for bug reports, feature requests and so on on GitHub. There is still room for fine-tuning, but it's reached a state to show it to you and get feedback. I think that this can lead to better bug reports. You can see the result in my repo: https://github.com/KristjanESPERANTO/MagicMirror/issues/new/choose Feel free to create new issues for testing. What do you think? Do we want to pursue this further? # Conflicts: # CHANGELOG.md
1 parent c24de64 commit 9c9a535

7 files changed

+277
-81
lines changed

‎.github/CONTRIBUTING.md

-28
Original file line numberDiff line numberDiff line change
@@ -36,31 +36,3 @@ To run all tests, use `npm run test`.
3636

3737
The specific test commands are defined in `package.json`.
3838
So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`.
39-
40-
## Submitting Issues
41-
42-
Please only submit reproducible issues.
43-
44-
If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
45-
46-
Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
47-
48-
When submitting a new issue, please supply the following information:
49-
50-
**Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
51-
52-
**Node Version**: Make sure it's version 20 or later (recommended is 22).
53-
54-
**MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
55-
56-
**Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
57-
58-
**Steps to Reproduce**: List the step by step process to reproduce the issue.
59-
60-
**Expected Results**: Describe what you expected to see.
61-
62-
**Actual Results**: Describe what you actually saw.
63-
64-
**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
65-
66-
**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

‎.github/ISSUE_TEMPLATE.md

-52
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
name: 🐛 Report a problem
2+
description: Report an issue with MagicMirror² 🚨
3+
title: "[Bug] {{ brief description }}"
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reporting a bug! Please fill in the following template to help us reproduce the issue.
11+
Please only submit reproducible issues. If you're not sure if it's a real bug or if it's just you, please open a topic on the forum.
12+
- type: textarea
13+
id: environment
14+
attributes:
15+
label: Environment
16+
description: |
17+
Please tell us about how your MagicMirror² is set up.
18+
19+
Optimal would be the systeminformation from the logs, which looks like this:
20+
```bash
21+
[2025-01-14 20:05:03.529] [INFO] System information:
22+
### SYSTEM: manufacturer: Raspberry Pi Foundation; model: Raspberry Pi 4 Model B Rev 1.5; virtual: false
23+
### OS: platform: linux; distro: Debian GNU/Linux; release: 12; arch: arm64; kernel: 6.1.21-v8+
24+
### VERSIONS: electron: 31.2.1; used node: 20.15.0; installed node: 22.4.1; npm: 10.8.1; pm2:
25+
### OTHER: timeZone: Europe/Berlin; ELECTRON_ENABLE_GPU: undefined
26+
```
27+
28+
If you can't provide this information, please provide the following:
29+
- MagicMirror² version: Can be found in the `package.json` file. Please use the latest version before reporting a bug.
30+
- Node version: Run `node -v` to find out. Make sure it's version 20 or later (recommended is 22).
31+
- npm version: Run `npm -v` to find out.
32+
- Platform: Are you using a Raspberry Pi (2/3/4/5), Windows, Mac, Linux, Docker, or something else?
33+
value: |
34+
MagicMirror² version:
35+
Node version:
36+
npm version:
37+
Platform:
38+
validations:
39+
required: true
40+
- type: dropdown
41+
id: start-option
42+
attributes:
43+
label: Which start option are you using?
44+
description: |
45+
Please keep in mind that some problems are specific to certain start options.
46+
options:
47+
- "npm run start"
48+
- "npm run start:wayland"
49+
- "npm run start:windows"
50+
- "npm run start:x11"
51+
- "npm run server"
52+
- "node clientonly --address ... --port ..."
53+
validations:
54+
required: true
55+
- type: dropdown
56+
id: pm2
57+
attributes:
58+
label: Are you using PM2?
59+
options:
60+
- "No"
61+
- "Yes"
62+
- "I don't know"
63+
validations:
64+
required: true
65+
- type: dropdown
66+
id: module
67+
attributes:
68+
label: Module
69+
description: |
70+
If the issue is related to a specific module, please provide the name of the module.
71+
Note: Please don't report issues with 3rd party modules here. Report them on the module's repository.
72+
options:
73+
- "alert"
74+
- "calendar"
75+
- "clock"
76+
- "compliments"
77+
- "helloworld"
78+
- "newsfeed"
79+
- "updatenotification"
80+
- "weather"
81+
- type: checkboxes
82+
id: module-disabled
83+
attributes:
84+
label: Have you tried disabling other modules?
85+
options:
86+
- label: "Yes"
87+
- label: "No"
88+
- type: checkboxes
89+
id: search
90+
attributes:
91+
label: Have you searched if someone else has already reported the issue on the forum or in the issues?
92+
options:
93+
- label: "Yes"
94+
required: true
95+
- type: textarea
96+
id: description
97+
attributes:
98+
label: What did you do?
99+
description: |
100+
Please include a *minimal* reproduction case. List the step by step process to reproduce the issue.
101+
You can use Markdown in this field.
102+
value: |
103+
<details>
104+
<summary>Configuration</summary>
105+
106+
```
107+
<!-- Paste your configuration here. Don't forget to remove any sensitive information! -->
108+
```
109+
</details>
110+
111+
```js
112+
<!-- Paste relevant code here -->
113+
```
114+
115+
Steps to reproduce the issue:
116+
validations:
117+
required: true
118+
- type: textarea
119+
id: expectation
120+
attributes:
121+
label: What did you expect to happen?
122+
description: |
123+
You can use Markdown in this field.
124+
validations:
125+
required: true
126+
- type: textarea
127+
id: lint-output
128+
attributes:
129+
label: What actually happened?
130+
description: |
131+
Please copy-paste relevant log output or error messages.
132+
You can use Markdown in this field.
133+
validations:
134+
required: true
135+
136+
- type: textarea
137+
id: comments
138+
attributes:
139+
label: Additional comments
140+
description: |
141+
Is there anything else that's important for the team to know?
142+
Fill out all fields and provide as much information as possible.
143+
Adding screenshots might help us understand your problem better.
144+
145+
- type: checkboxes
146+
attributes:
147+
label: Participation
148+
options:
149+
- label: "I am willing to submit a pull request for this change."
150+
required: false
151+
152+
- type: markdown
153+
attributes:
154+
value: Please **do not** open a pull request until this issue has been accepted by the team.

‎.github/ISSUE_TEMPLATE/change_request.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: 🔀 Request a change
2+
description: Request a change that is not a bug fix, a feature request or a support request.
3+
title: "[Change Request] {{ brief description }}"
4+
labels:
5+
- enhancement
6+
- core
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: Thanks for requesting a change! Please fill in the following template to help us understand your request.
11+
- type: textarea
12+
attributes:
13+
label: What problem do you want to solve with this change?
14+
description: |
15+
Please explain your use case in as much detail as possible.
16+
placeholder: |
17+
Currently...
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: What do you think is the correct solution?
23+
description: |
24+
Please explain how you'd like to change MagicMirror² to address the problem.
25+
placeholder: |
26+
I'd like MagicMirror² to...
27+
validations:
28+
required: true
29+
- type: checkboxes
30+
attributes:
31+
label: Participation
32+
options:
33+
- label: I am willing to submit a pull request for this change.
34+
required: false
35+
- type: markdown
36+
attributes:
37+
value: Please **do not** open a pull request until this issue has been accepted by the team.
38+
- type: textarea
39+
attributes:
40+
label: Additional comments
41+
description: Is there anything else that's important for the team to know?

‎.github/ISSUE_TEMPLATE/config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📚 Documentation
4+
url: https://github.com/MagicMirrorOrg/MagicMirror-Documentation/issues
5+
about: This issue tracker is not for documentation issues. Please file documentation issues on the docs repo.
6+
- name: 🤔 Support Question
7+
url: https://forum.magicmirror.builders/
8+
about: Problems installing or configuring your MagicMirror? Please post your question on the MagicMirror² Forum.
9+
- name: 💬 Exchange of ideas
10+
url: https://discord.gg/AmGBBwPph5
11+
about: This issue tracker is not for general discussion. Please use the Discord channel.
12+
- name: 📦 Issues with a 3rd-party module
13+
url: https://kristjanesperanto.github.io/MagicMirror-3rd-Party-Modules/
14+
about: This issue tracker is not for 3rd-party module issues. Please file 3rd-party module issues on the module's repo.

‎.github/ISSUE_TEMPLATE/feature_request.yml

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: 🚀 Feature Request
2+
description: Suggest a new feature for MagicMirror² 💡
3+
title: "[Feature Request] {{ brief description }}"
4+
body:
5+
- type: checkboxes
6+
id: prerequisites
7+
attributes:
8+
label: Prerequisites
9+
description: Please ensure you have completed all of the following.
10+
options:
11+
- label: I am running the latest version of MagicMirror², and know that this feature is not available now.
12+
required: true
13+
- label: I know my issue is not related to a third-party module.
14+
required: true
15+
- label: I have searched for [existing issues](https://github.com/MagicMirrorOrg/MagicMirror/issues) that already include this feature request, without success.
16+
required: true
17+
18+
- type: textarea
19+
id: description
20+
attributes:
21+
label: Describe the Feature Request
22+
description: A clear and concise description of what the feature does.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: use-case
28+
attributes:
29+
label: Describe the Use Case
30+
description: A clear and concise use case for what problem this feature would solve.
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: proposed-solution
36+
attributes:
37+
label: Describe Preferred Solution
38+
description: A clear and concise description of how you want this feature to be added to MagicMirror².
39+
40+
- type: textarea
41+
id: alternatives-considered
42+
attributes:
43+
label: Describe Alternatives
44+
description: A clear and concise description of any alternative solutions or features you have considered.
45+
46+
- type: textarea
47+
id: related-code
48+
attributes:
49+
label: Related Code
50+
description: If you are able to illustrate the feature request with an example, please provide a sample here.
51+
52+
- type: textarea
53+
id: additional-information
54+
attributes:
55+
label: Additional Information
56+
description: List any other information that is relevant to your issue. Related issues, suggestions on how to implement, Stack Overflow links, forum links, etc.
57+
58+
- type: checkboxes
59+
attributes:
60+
label: Participation
61+
options:
62+
- label: I am willing to submit a pull request for this change.
63+
required: false
64+
65+
- type: markdown
66+
attributes:
67+
value: Please **do not** open a pull request until this issue has been accepted by the team.

‎.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Hello and thank you for wanting to contribute to the MagicMirror² project
1+
Hello and thank you for wanting to contribute to the MagicMirror² project!
22

33
**Please make sure that you have followed these 4 rules before submitting your Pull Request:**
44

0 commit comments

Comments
 (0)