-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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?
- Loading branch information
1 parent
6e40c44
commit 77fe011
Showing
8 changed files
with
278 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| name: 🐛 Report a problem | ||
| description: Report an issue with MagicMirror² 🚨 | ||
| title: "[Bug] {{ brief description }}" | ||
| labels: | ||
| - bug | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for reporting a bug! Please fill in the following template to help us reproduce the issue. | ||
| 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. | ||
| - type: textarea | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| description: | | ||
| Please tell us about how your MagicMirror² is set up. | ||
| Optimal would be the systeminformation from the logs, which looks like this: | ||
| ```bash | ||
| [2025-01-14 20:05:03.529] [INFO] System information: | ||
| ### SYSTEM: manufacturer: Raspberry Pi Foundation; model: Raspberry Pi 4 Model B Rev 1.5; virtual: false | ||
| ### OS: platform: linux; distro: Debian GNU/Linux; release: 12; arch: arm64; kernel: 6.1.21-v8+ | ||
| ### VERSIONS: electron: 31.2.1; used node: 20.15.0; installed node: 22.4.1; npm: 10.8.1; pm2: | ||
| ### OTHER: timeZone: Europe/Berlin; ELECTRON_ENABLE_GPU: undefined | ||
| ``` | ||
| If you can't provide this information, please provide the following: | ||
| - MagicMirror² version: Can be found in the `package.json` file. Please use the latest version before reporting a bug. | ||
| - Node version: Run `node -v` to find out. Make sure it's version 20 or later (recommended is 22). | ||
| - npm version: Run `npm -v` to find out. | ||
| - Platform: Are you using a Raspberry Pi (2/3/4/5), Windows, Mac, Linux, Docker, or something else? | ||
| value: | | ||
| MagicMirror² version: | ||
| Node version: | ||
| npm version: | ||
| Platform: | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: start-option | ||
| attributes: | ||
| label: Which start option are you using? | ||
| description: | | ||
| Please keep in mind that some problems are specific to certain start options. | ||
| options: | ||
| - "npm run start" | ||
| - "npm run start:wayland" | ||
| - "npm run start:windows" | ||
| - "npm run start:x11" | ||
| - "npm run server" | ||
| - "node clientonly --address ... --port ..." | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: pm2 | ||
| attributes: | ||
| label: Are you using PM2? | ||
| options: | ||
| - "No" | ||
| - "Yes" | ||
| - "I don't know" | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: module | ||
| attributes: | ||
| label: Module | ||
| description: | | ||
| If the issue is related to a specific module, please provide the name of the module. | ||
| Note: Please don't report issues with 3rd party modules here. Report them on the module's repository. | ||
| options: | ||
| - "alert" | ||
| - "calendar" | ||
| - "clock" | ||
| - "compliments" | ||
| - "helloworld" | ||
| - "newsfeed" | ||
| - "updatenotification" | ||
| - "weather" | ||
| - type: checkboxes | ||
| id: module-disabled | ||
| attributes: | ||
| label: Have you tried disabling other modules? | ||
| options: | ||
| - label: "Yes" | ||
| - label: "No" | ||
| - type: checkboxes | ||
| id: search | ||
| attributes: | ||
| label: Have you searched if someone else has already reported the issue on the forum or in the issues? | ||
| options: | ||
| - label: "Yes" | ||
| required: true | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: What did you do? | ||
| description: | | ||
| Please include a *minimal* reproduction case. List the step by step process to reproduce the issue. | ||
| You can use Markdown in this field. | ||
| value: | | ||
| <details> | ||
| <summary>Configuration</summary> | ||
| ``` | ||
| <!-- Paste your configuration here. Don't forget to remove any sensitive information! --> | ||
| ``` | ||
| </details> | ||
| ```js | ||
| <!-- Paste relevant code here --> | ||
| ``` | ||
| Steps to reproduce the issue: | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expectation | ||
| attributes: | ||
| label: What did you expect to happen? | ||
| description: | | ||
| You can use Markdown in this field. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: lint-output | ||
| attributes: | ||
| label: What actually happened? | ||
| description: | | ||
| Please copy-paste relevant log output or error messages. | ||
| You can use Markdown in this field. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: comments | ||
| attributes: | ||
| label: Additional comments | ||
| description: | | ||
| Is there anything else that's important for the team to know? | ||
| Fill out all fields and provide as much information as possible. | ||
| Adding screenshots might help us understand your problem better. | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Participation | ||
| options: | ||
| - label: "I am willing to submit a pull request for this change." | ||
| required: false | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: Please **do not** open a pull request until this issue has been accepted by the team. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| name: 🔀 Request a change | ||
| description: Request a change that is not a bug fix, a feature request or a support request. | ||
| title: "[Change Request] {{ brief description }}" | ||
| labels: | ||
| - enhancement | ||
| - core | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: Thanks for requesting a change! Please fill in the following template to help us understand your request. | ||
| - type: textarea | ||
| attributes: | ||
| label: What problem do you want to solve with this change? | ||
| description: | | ||
| Please explain your use case in as much detail as possible. | ||
| placeholder: | | ||
| Currently... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: What do you think is the correct solution? | ||
| description: | | ||
| Please explain how you'd like to change MagicMirror² to address the problem. | ||
| placeholder: | | ||
| I'd like MagicMirror² to... | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Participation | ||
| options: | ||
| - label: I am willing to submit a pull request for this change. | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: Please **do not** open a pull request until this issue has been accepted by the team. | ||
| - type: textarea | ||
| attributes: | ||
| label: Additional comments | ||
| description: Is there anything else that's important for the team to know? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: 📚 Documentation | ||
| url: /~https://github.com/MagicMirrorOrg/MagicMirror-Documentation/issues | ||
| about: This issue tracker is not for documentation issues. Please file documentation issues on the docs repo. | ||
| - name: 🤔 Support Question | ||
| url: https://forum.magicmirror.builders/ | ||
| about: Problems installing or configuring your MagicMirror? Please post your question on the MagicMirror² Forum. | ||
| - name: 💬 Exchange of ideas | ||
| url: https://discord.gg/AmGBBwPph5 | ||
| about: This issue tracker is not for general discussion. Please use the Discord channel. | ||
| - name: 📦 Issues with a 3rd-party module | ||
| url: https://kristjanesperanto.github.io/MagicMirror-3rd-Party-Modules/ | ||
| about: This issue tracker is not for 3rd-party module issues. Please file 3rd-party module issues on the module's repo. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| name: 🚀 Feature Request | ||
| description: Suggest a new feature for MagicMirror² 💡 | ||
| title: "[Feature Request] {{ brief description }}" | ||
| body: | ||
| - type: checkboxes | ||
| id: prerequisites | ||
| attributes: | ||
| label: Prerequisites | ||
| description: Please ensure you have completed all of the following. | ||
| options: | ||
| - label: I am running the latest version of MagicMirror², and know that this feature is not available now. | ||
| required: true | ||
| - label: I know my issue is not related to a third-party module. | ||
| required: true | ||
| - label: I have searched for [existing issues](/~https://github.com/MagicMirrorOrg/MagicMirror/issues) that already include this feature request, without success. | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Describe the Feature Request | ||
| description: A clear and concise description of what the feature does. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: use-case | ||
| attributes: | ||
| label: Describe the Use Case | ||
| description: A clear and concise use case for what problem this feature would solve. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: proposed-solution | ||
| attributes: | ||
| label: Describe Preferred Solution | ||
| description: A clear and concise description of how you want this feature to be added to MagicMirror². | ||
|
|
||
| - type: textarea | ||
| id: alternatives-considered | ||
| attributes: | ||
| label: Describe Alternatives | ||
| description: A clear and concise description of any alternative solutions or features you have considered. | ||
|
|
||
| - type: textarea | ||
| id: related-code | ||
| attributes: | ||
| label: Related Code | ||
| description: If you are able to illustrate the feature request with an example, please provide a sample here. | ||
|
|
||
| - type: textarea | ||
| id: additional-information | ||
| attributes: | ||
| label: Additional Information | ||
| description: List any other information that is relevant to your issue. Related issues, suggestions on how to implement, Stack Overflow links, forum links, etc. | ||
|
|
||
| - type: checkboxes | ||
| attributes: | ||
| label: Participation | ||
| options: | ||
| - label: I am willing to submit a pull request for this change. | ||
| required: false | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: Please **do not** open a pull request until this issue has been accepted by the team. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters