-
-
Notifications
You must be signed in to change notification settings - Fork 362
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New bug report and feature request templates
- Loading branch information
Showing
6 changed files
with
366 additions
and
45 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| name: Bug Report (projectM Users) | ||
| description: File a report for a use-related issue with projectM, e.g. application crashes, rendering and audio recording problems. | ||
| title: "[APP BUG] " | ||
| labels: ["triage","bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| You have encountered an issue with a projectM frontend or a plug-in for a third-party application? We're glad to see you reporting that to us! To understand your problem in detail, please fill out this form to the best of your knowledge so we can narrow down and fix it as fast as possible. | ||
| If you want to report an issue regarding projectM _development_, e.g. building any project, integrating it into another project or having API issues, please go back and use the developer bug form instead. We ask a few different questions there. | ||
| ### Bugs regarding the projectM Android App | ||
| Note that **we will not accept bug reports for the Android apps** in the Google Play Store. These apps are not being developed by the projectM team. Please report issues directly to the app author via the contact information provided in the Play Store. | ||
| - type: checkboxes | ||
| id: reporter_ack | ||
| attributes: | ||
| label: "Please confirm the following points:" | ||
| options: | ||
| - label: This report is NOT about the Android apps in the Play Store | ||
| required: true | ||
| - label: I have [searched the project page](https://github.com/search?q=org%3AprojectM-visualizer+type%3Aissue+&type=issues) to check if the issue was already reported | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Now, tell us more about where and with which version you encountered the issue. We will take care about moving the report to the correct repository during triage. | ||
| - type: dropdown | ||
| id: project | ||
| attributes: | ||
| label: Affected Application | ||
| description: In which application did you encounter an issue? | ||
| options: | ||
| - I don't know / Other (please elaborate below) | ||
| - projectM Standalone SDL2 Frontend (includes the Steam app) | ||
| - projectM Standalone Qt Frontend (projectm-pulseaudio) | ||
| - Windows Store App | ||
| - Apple Music Plug-in for macOS | ||
| - Third-Party Integration (Kodi, VLC, etc. - please specify below) | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Affected Version | ||
| description: Please provide the affected version of the application/plug-in, if you know. You can provide other relevant versions in the description at the end. | ||
| placeholder: e.g. 4.1.1 | ||
| validations: | ||
| required: false | ||
| - type: dropdown | ||
| id: operating_system | ||
| attributes: | ||
| label: Operating System | ||
| description: If your issue _only_ affects a specific operating system, please select it below. If in doubt, leave it as-is. | ||
| options: | ||
| - Windows | ||
| - macOS | ||
| - Linux (Desktop) | ||
| - Linux (Embedded, e.g. Raspberry Pi) | ||
| - Web Browser | ||
| - Other, all or not relevant | ||
| default: 5 | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: project_specifics | ||
| attributes: | ||
| label: Additional Application Details | ||
| description: If you have additional information that helps us identify the affected application and version, please tell us here in more detail. You can also upload screenshots with helpful information in this text field. | ||
| placeholder: "Describe where you downloaded the application or upload a screenshot of the about dialog" | ||
| validations: | ||
| required: false | ||
| - type: dropdown | ||
| id: defect_kind | ||
| attributes: | ||
| label: Type of Defect | ||
| description: Please select which kind of issue you've encountered. | ||
| options: | ||
| - Crash (unexpected closing, OS crash dialog) | ||
| - Graphical issue (rendering glitches, black screen, heavy flickering) | ||
| - Low FPS (or continuously high CPU/GPU usage) | ||
| - Audio issue (no audio recording, delayed reaction) | ||
| - Other | ||
| default: 0 | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: log_output | ||
| attributes: | ||
| label: Log Output | ||
| description: Paste any log output here. If a log is very large, e.g. more than 50 lines, please upload it as a file attachment in the description field below. | ||
| render: shell | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Tip: For the new projectM SDL2 frontend, you can find the log file `projectMSDL.log` at `%APPDATA%\projectM\` on Windows, `~/.config/projectM/` on Linux and `~/Library/Preferences/projectM/` on macOS. | ||
| - type: textarea | ||
| id: issue_text | ||
| attributes: | ||
| label: Describe the Issue | ||
| description: Please describe the problem in detail. Most importantly, include any information that helps us to reproduce and narrow down the issue. You can also upload additional log files or screenshots. | ||
| placeholder: "Steps to reproduce, detailed information about the issue, example presets and other relevant information" | ||
| validations: | ||
| required: true |
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,148 @@ | ||
| name: Bug Report (Development) | ||
| description: File a report for a development-related issue with projectM, e.g. build failures, API/integration issues, bugs or questions regarding projectM's code. | ||
| title: "[DEV BUG] " | ||
| labels: ["triage","bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to report an issue with projectM! To understand your problem in detail, please fill out this form, so we can narrow down and help you solve the issue as fast as possible. | ||
| If you want to report an issue encountered while _running a projectM application or plug-in_, e.g. crashes, rendering glitches etc., please go back and use the user bug form instead. We ask a few different questions there. | ||
| ### Bugs regarding the projectM Android App | ||
| Note that **we will not accept bug reports for the Android apps** in the Google Play Store. These apps are not being developed by the projectM team. Please report issues directly to the app author via the contact information provided in the Play Store. | ||
| - type: checkboxes | ||
| id: reporter_ack | ||
| attributes: | ||
| label: "Please confirm the following points:" | ||
| options: | ||
| - label: This report is NOT about the Android apps in the Play Store | ||
| required: true | ||
| - label: I have [searched the project page](https://github.com/search?q=org%3AprojectM-visualizer+type%3Aissue+&type=issues) to check if the issue was already reported | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Now, tell us more about where and with which version you encountered the issue. This is either the library you want to integrate in your app or the project you're trying to build. | ||
| - type: dropdown | ||
| id: project | ||
| attributes: | ||
| label: Affected Project | ||
| description: Which project is affected by the issue? | ||
| options: | ||
| - libprojectM (including the playlist library) | ||
| - projectM Expression Evaluation Library | ||
| - projectM Standalone SDL2 Frontend (includes the Steam app) | ||
| - projectM Standalone Qt Frontend (projectm-pulseaudio) | ||
| - Windows Store App | ||
| - Apple Music Plug-in for macOS | ||
| - Third-Party Integration (Kodi, VLC, etc. - please specify below) | ||
| - I don't know / Other (please elaborate below) | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Affected Version | ||
| description: | | ||
| Please provide the affected version, Git tag or specific Git hash of the project in question. | ||
| Add other relevant versions, e.g. of dependencies and build tools, in the "additional details" field below. | ||
| placeholder: e.g. 4.1.1 or 3f885d | ||
| validations: | ||
| required: false | ||
| - type: dropdown | ||
| id: operating_system | ||
| attributes: | ||
| label: Operating Systems and Architectures | ||
| description: Please select all affected operating systems and architectures below. If in doubt, use the first option. **Multiple choices are possible.** | ||
| options: | ||
| - Don't know, other or not relevant | ||
| - All | ||
| - Windows (x32) | ||
| - Windows (x64) | ||
| - Windows (ARM64) | ||
| - macOS (x86_64) | ||
| - macOS (aarch64) | ||
| - Linux (x86) | ||
| - Linux (x86_64) | ||
| - Linux (aarch64) | ||
| - Android (arm64-v8a) | ||
| - Android (armeabi-v7a) | ||
| - Android (x86) | ||
| - Android (x86_64) | ||
| - iOS / tvOS | ||
| - BSD | ||
| - Emscripten | ||
| - WebAssembly (other compiler) | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: build_tools | ||
| attributes: | ||
| label: Build Tools | ||
| description: Please select the tools you've used when encountering the issue, if appropriate. Please provide additional version information and tools not listed here in the text field below. **Multiple choices are possible.** | ||
| options: | ||
| - "Compiler: Microsoft Windows SDK" | ||
| - "Compiler: GNU GCC" | ||
| - "Compiler: GNU GCC (MinGW)" | ||
| - "Compiler: Clang" | ||
| - "Compiler: Clang (Android NDK)" | ||
| - "Compiler: AppleClang (Xcode)" | ||
| - "Build Tool: MSBuild" | ||
| - "Build Tool: GNU Make" | ||
| - "Build Tool: Ninja Build" | ||
| - "Build Tool: xcodebuild" | ||
| - "Build Tool: CMake" | ||
| - "Dependency Manager: vcpkg" | ||
| - "Dependency Manager: Homebrew" | ||
| - "Dependency Manager: pkgconfig" | ||
| multiple: true | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: project_specifics | ||
| attributes: | ||
| label: Additional Project, OS and Toolset Details | ||
| description: Please provide all additional information that helps us to reproduce the issue. This includes specific tool and dependency versions. | ||
| placeholder: "Using Visual Studio 2022, Linux distribution and version, building on a Raspberry Pi, ..." | ||
| validations: | ||
| required: false | ||
| - type: dropdown | ||
| id: defect_kind | ||
| attributes: | ||
| label: Type of Defect | ||
| description: Please select which kind of issue you want to report. | ||
| options: | ||
| - Build failure (compiler/linker or toolset error) | ||
| - Test failure (existing unit/integration tests fail) | ||
| - CMake/CPack issue (configuration, build, install or packaging) | ||
| - Specific bug in projectM code (please link the code in question) | ||
| - API problem (API function not working or failing unexpectedly) | ||
| - Crash (unhandled exceptions, segmentation faults) | ||
| - Graphical issue (rendering glitches, no or broken rendering result) | ||
| - Low FPS (or continuously high CPU/GPU usage) | ||
| - Audio issue (passing audio data not working) | ||
| - Missing or outdated documentation | ||
| - Other | ||
| default: 0 | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: log_output | ||
| attributes: | ||
| label: Log Output | ||
| description: Paste any _relevant_ build/log output here, e.g. compiler errors or debugger output plus required lines for context. If a log is very large (more than 50 lines), please upload it as a file attachment in the description field below. | ||
| render: shell | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: issue_text | ||
| attributes: | ||
| label: Describe the Issue | ||
| description: Please describe the problem in detail. Most importantly, include any information that helps us to reproduce and narrow down the issue. You can also upload additional log files or screenshots. | ||
| placeholder: "Steps to reproduce, detailed information about the issue, example presets and other relevant information" | ||
| validations: | ||
| required: true |
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,72 @@ | ||
| name: Feature Request | ||
| description: If you're missing an important feature in any projectM app or library, or have a great idea we should implement, use this form. | ||
| title: "[FEATURE] " | ||
| labels: ["triage","enhancement"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ### Feature requests regarding the projectM Android App | ||
| Note that **we cannot change anything in the Android apps** in the Google Play Store. These apps are proprietary/closed-source and not being developed by the projectM team. Please request features directly from the app author via the contact information provided in the Play Store. | ||
| - type: checkboxes | ||
| id: reporter_ack | ||
| attributes: | ||
| label: "Please confirm the following points:" | ||
| options: | ||
| - label: This feature request is NOT for the Android apps in the Play Store | ||
| required: true | ||
| - label: I have [searched the project page](https://github.com/search?q=org%3AprojectM-visualizer+type%3Aissue+&type=issues) to check if a similar request was already made | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Please tell us for which application or project you want to suggest a feature. We will take care about moving the request to the correct repository during triage. | ||
| - type: dropdown | ||
| id: project | ||
| attributes: | ||
| label: Application or Project | ||
| description: For which application or project are you suggesting a new feature or enhancement? | ||
| options: | ||
| - I don't know / Multiple / Other (please elaborate below) | ||
| - projectM Standalone SDL2 Frontend (includes the Steam app) | ||
| - projectM Standalone Qt Frontend (projectm-pulseaudio) | ||
| - Windows Store App | ||
| - Apple Music Plug-in for macOS | ||
| - Third-Party Integration (Kodi, VLC, etc. - please specify below) | ||
| - libprojectM (including the playlist library) | ||
| - projectM Expression Evaluation Library | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: related_problem | ||
| attributes: | ||
| label: Is Your Enhancement Related to a Problem? | ||
| description: If your suggestion is based on a problem you have with an existing application, e.g. frustrating behavior, please describe it here. | ||
| placeholder: "Missing hotkeys, strange window behavior, ..." | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: suggested_solution | ||
| attributes: | ||
| label: Your Suggested Enhancement | ||
| description: | | ||
| Please tell us what feature, enhancement or solution you have in mind. Describe it as clear and concise as possible. | ||
| The more information you give, the easier it is for us to understand and implement it. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alt_solution | ||
| attributes: | ||
| label: Alternative Solutions | ||
| description: If you have any alternative solutions to the above suggestion, e.g. if it's too complex or not technically feasible, please tell us below. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: additional_context | ||
| attributes: | ||
| label: Additional Context | ||
| description: Any other context you'd like to add, including screenshots of similar features from other applications. | ||
| placeholder: "I've seen this in application XY / It works in Milkdrop / Attached a screenshot with an example..." | ||
| validations: | ||
| required: false |
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,40 @@ | ||
| name: General Question / Other Request | ||
| description: If you don't want to report a bug or request a feature, use this form to ask about anything else. | ||
| title: "[REQUEST] " | ||
| labels: ["triage","question"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ### Requests regarding the projectM Android App | ||
| Note that **we cannot answer questions regarding the Android apps** in the Google Play Store. These apps are not being developed by the projectM team. Please contact the app author directly via the information provided in the Play Store. | ||
| - type: checkboxes | ||
| id: reporter_ack | ||
| attributes: | ||
| label: "Please confirm the following points:" | ||
| options: | ||
| - label: This question is NOT about the Android apps in the Play Store | ||
| required: true | ||
| - label: I have [searched the project page](https://github.com/search?q=org%3AprojectM-visualizer+type%3Aissue+&type=issues) to check if the question was already asked elsewhere | ||
| required: true | ||
| - type: dropdown | ||
| id: topic | ||
| attributes: | ||
| label: Topic | ||
| description: What is the general topic of your question or request? | ||
| options: | ||
| - General Request | ||
| - Development and Contributing | ||
| - Applications and Plug-Ins, Third-Party Software | ||
| - Third-Party Application Interfaces and Remote Control | ||
| - Milkdrop Presets | ||
| - Documentation and/or the projectM Wiki | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: question | ||
| attributes: | ||
| label: Your Request | ||
| description: Tell us what your request is about. The more details you provide, the easier it is for us to answer your question and find a solution. | ||
| validations: | ||
| required: true |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.