Skip to content

Commit 6e817a1

Browse files
kblaschkekblaschke
committed
New bug report and feature request templates
1 parent ac77498 commit 6e817a1

6 files changed

+366
-45
lines changed

‎.github/ISSUE_TEMPLATE/1-bug_report_user.yml

+106
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: Bug Report (projectM Users)
2+
description: File a report for a use-related issue with projectM, e.g. application crashes, rendering and audio recording problems.
3+
title: "[APP BUG] "
4+
labels: ["triage","bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
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.
10+
11+
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.
12+
13+
### Bugs regarding the projectM Android App
14+
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.
15+
- type: checkboxes
16+
id: reporter_ack
17+
attributes:
18+
label: "Please confirm the following points:"
19+
options:
20+
- label: This report is NOT about the Android apps in the Play Store
21+
required: true
22+
- 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
23+
required: true
24+
- type: markdown
25+
attributes:
26+
value: |
27+
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.
28+
- type: dropdown
29+
id: project
30+
attributes:
31+
label: Affected Application
32+
description: In which application did you encounter an issue?
33+
options:
34+
- I don't know / Other (please elaborate below)
35+
- projectM Standalone SDL2 Frontend (includes the Steam app)
36+
- projectM Standalone Qt Frontend (projectm-pulseaudio)
37+
- Windows Store App
38+
- Apple Music Plug-in for macOS
39+
- Third-Party Integration (Kodi, VLC, etc. - please specify below)
40+
validations:
41+
required: true
42+
- type: input
43+
id: version
44+
attributes:
45+
label: Affected Version
46+
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.
47+
placeholder: e.g. 4.1.1
48+
validations:
49+
required: false
50+
- type: dropdown
51+
id: operating_system
52+
attributes:
53+
label: Operating System
54+
description: If your issue _only_ affects a specific operating system, please select it below. If in doubt, leave it as-is.
55+
options:
56+
- Windows
57+
- macOS
58+
- Linux (Desktop)
59+
- Linux (Embedded, e.g. Raspberry Pi)
60+
- Web Browser
61+
- Other, all or not relevant
62+
default: 5
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: project_specifics
67+
attributes:
68+
label: Additional Application Details
69+
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.
70+
placeholder: "Describe where you downloaded the application or upload a screenshot of the about dialog"
71+
validations:
72+
required: false
73+
- type: dropdown
74+
id: defect_kind
75+
attributes:
76+
label: Type of Defect
77+
description: Please select which kind of issue you've encountered.
78+
options:
79+
- Crash (unexpected closing, OS crash dialog)
80+
- Graphical issue (rendering glitches, black screen, heavy flickering)
81+
- Low FPS (or continuously high CPU/GPU usage)
82+
- Audio issue (no audio recording, delayed reaction)
83+
- Other
84+
default: 0
85+
validations:
86+
required: true
87+
- type: textarea
88+
id: log_output
89+
attributes:
90+
label: Log Output
91+
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.
92+
render: shell
93+
validations:
94+
required: false
95+
- type: markdown
96+
attributes:
97+
value: |
98+
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.
99+
- type: textarea
100+
id: issue_text
101+
attributes:
102+
label: Describe the Issue
103+
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.
104+
placeholder: "Steps to reproduce, detailed information about the issue, example presets and other relevant information"
105+
validations:
106+
required: true

‎.github/ISSUE_TEMPLATE/2-bug_report_developer.yml

+148
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
name: Bug Report (Development)
2+
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.
3+
title: "[DEV BUG] "
4+
labels: ["triage","bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
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.
10+
11+
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.
12+
13+
### Bugs regarding the projectM Android App
14+
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.
15+
- type: checkboxes
16+
id: reporter_ack
17+
attributes:
18+
label: "Please confirm the following points:"
19+
options:
20+
- label: This report is NOT about the Android apps in the Play Store
21+
required: true
22+
- 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
23+
required: true
24+
- type: markdown
25+
attributes:
26+
value: |
27+
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.
28+
- type: dropdown
29+
id: project
30+
attributes:
31+
label: Affected Project
32+
description: Which project is affected by the issue?
33+
options:
34+
- libprojectM (including the playlist library)
35+
- projectM Expression Evaluation Library
36+
- projectM Standalone SDL2 Frontend (includes the Steam app)
37+
- projectM Standalone Qt Frontend (projectm-pulseaudio)
38+
- Windows Store App
39+
- Apple Music Plug-in for macOS
40+
- Third-Party Integration (Kodi, VLC, etc. - please specify below)
41+
- I don't know / Other (please elaborate below)
42+
validations:
43+
required: true
44+
- type: input
45+
id: version
46+
attributes:
47+
label: Affected Version
48+
description: |
49+
Please provide the affected version, Git tag or specific Git hash of the project in question.
50+
51+
Add other relevant versions, e.g. of dependencies and build tools, in the "additional details" field below.
52+
placeholder: e.g. 4.1.1 or 3f885d
53+
validations:
54+
required: false
55+
- type: dropdown
56+
id: operating_system
57+
attributes:
58+
label: Operating Systems and Architectures
59+
description: Please select all affected operating systems and architectures below. If in doubt, use the first option. **Multiple choices are possible.**
60+
options:
61+
- Don't know, other or not relevant
62+
- All
63+
- Windows (x32)
64+
- Windows (x64)
65+
- Windows (ARM64)
66+
- macOS (x86_64)
67+
- macOS (aarch64)
68+
- Linux (x86)
69+
- Linux (x86_64)
70+
- Linux (aarch64)
71+
- Android (arm64-v8a)
72+
- Android (armeabi-v7a)
73+
- Android (x86)
74+
- Android (x86_64)
75+
- iOS / tvOS
76+
- BSD
77+
- Emscripten
78+
- WebAssembly (other compiler)
79+
multiple: true
80+
validations:
81+
required: true
82+
- type: dropdown
83+
id: build_tools
84+
attributes:
85+
label: Build Tools
86+
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.**
87+
options:
88+
- "Compiler: Microsoft Windows SDK"
89+
- "Compiler: GNU GCC"
90+
- "Compiler: GNU GCC (MinGW)"
91+
- "Compiler: Clang"
92+
- "Compiler: Clang (Android NDK)"
93+
- "Compiler: AppleClang (Xcode)"
94+
- "Build Tool: MSBuild"
95+
- "Build Tool: GNU Make"
96+
- "Build Tool: Ninja Build"
97+
- "Build Tool: xcodebuild"
98+
- "Build Tool: CMake"
99+
- "Dependency Manager: vcpkg"
100+
- "Dependency Manager: Homebrew"
101+
- "Dependency Manager: pkgconfig"
102+
multiple: true
103+
validations:
104+
required: false
105+
- type: textarea
106+
id: project_specifics
107+
attributes:
108+
label: Additional Project, OS and Toolset Details
109+
description: Please provide all additional information that helps us to reproduce the issue. This includes specific tool and dependency versions.
110+
placeholder: "Using Visual Studio 2022, Linux distribution and version, building on a Raspberry Pi, ..."
111+
validations:
112+
required: false
113+
- type: dropdown
114+
id: defect_kind
115+
attributes:
116+
label: Type of Defect
117+
description: Please select which kind of issue you want to report.
118+
options:
119+
- Build failure (compiler/linker or toolset error)
120+
- Test failure (existing unit/integration tests fail)
121+
- CMake/CPack issue (configuration, build, install or packaging)
122+
- Specific bug in projectM code (please link the code in question)
123+
- API problem (API function not working or failing unexpectedly)
124+
- Crash (unhandled exceptions, segmentation faults)
125+
- Graphical issue (rendering glitches, no or broken rendering result)
126+
- Low FPS (or continuously high CPU/GPU usage)
127+
- Audio issue (passing audio data not working)
128+
- Missing or outdated documentation
129+
- Other
130+
default: 0
131+
validations:
132+
required: true
133+
- type: textarea
134+
id: log_output
135+
attributes:
136+
label: Log Output
137+
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.
138+
render: shell
139+
validations:
140+
required: false
141+
- type: textarea
142+
id: issue_text
143+
attributes:
144+
label: Describe the Issue
145+
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.
146+
placeholder: "Steps to reproduce, detailed information about the issue, example presets and other relevant information"
147+
validations:
148+
required: true

‎.github/ISSUE_TEMPLATE/3-feature_request.yml

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Feature Request
2+
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.
3+
title: "[FEATURE] "
4+
labels: ["triage","enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
### Feature requests regarding the projectM Android App
10+
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.
11+
- type: checkboxes
12+
id: reporter_ack
13+
attributes:
14+
label: "Please confirm the following points:"
15+
options:
16+
- label: This feature request is NOT for the Android apps in the Play Store
17+
required: true
18+
- 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
19+
required: true
20+
- type: markdown
21+
attributes:
22+
value: |
23+
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.
24+
- type: dropdown
25+
id: project
26+
attributes:
27+
label: Application or Project
28+
description: For which application or project are you suggesting a new feature or enhancement?
29+
options:
30+
- I don't know / Multiple / Other (please elaborate below)
31+
- projectM Standalone SDL2 Frontend (includes the Steam app)
32+
- projectM Standalone Qt Frontend (projectm-pulseaudio)
33+
- Windows Store App
34+
- Apple Music Plug-in for macOS
35+
- Third-Party Integration (Kodi, VLC, etc. - please specify below)
36+
- libprojectM (including the playlist library)
37+
- projectM Expression Evaluation Library
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: related_problem
42+
attributes:
43+
label: Is Your Enhancement Related to a Problem?
44+
description: If your suggestion is based on a problem you have with an existing application, e.g. frustrating behavior, please describe it here.
45+
placeholder: "Missing hotkeys, strange window behavior, ..."
46+
validations:
47+
required: false
48+
- type: textarea
49+
id: suggested_solution
50+
attributes:
51+
label: Your Suggested Enhancement
52+
description: |
53+
Please tell us what feature, enhancement or solution you have in mind. Describe it as clear and concise as possible.
54+
55+
The more information you give, the easier it is for us to understand and implement it.
56+
validations:
57+
required: true
58+
- type: textarea
59+
id: alt_solution
60+
attributes:
61+
label: Alternative Solutions
62+
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.
63+
validations:
64+
required: false
65+
- type: textarea
66+
id: additional_context
67+
attributes:
68+
label: Additional Context
69+
description: Any other context you'd like to add, including screenshots of similar features from other applications.
70+
placeholder: "I've seen this in application XY / It works in Milkdrop / Attached a screenshot with an example..."
71+
validations:
72+
required: false

‎.github/ISSUE_TEMPLATE/4-general_question.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: General Question / Other Request
2+
description: If you don't want to report a bug or request a feature, use this form to ask about anything else.
3+
title: "[REQUEST] "
4+
labels: ["triage","question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
### Requests regarding the projectM Android App
10+
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.
11+
- type: checkboxes
12+
id: reporter_ack
13+
attributes:
14+
label: "Please confirm the following points:"
15+
options:
16+
- label: This question is NOT about the Android apps in the Play Store
17+
required: true
18+
- 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
19+
required: true
20+
- type: dropdown
21+
id: topic
22+
attributes:
23+
label: Topic
24+
description: What is the general topic of your question or request?
25+
options:
26+
- General Request
27+
- Development and Contributing
28+
- Applications and Plug-Ins, Third-Party Software
29+
- Third-Party Application Interfaces and Remote Control
30+
- Milkdrop Presets
31+
- Documentation and/or the projectM Wiki
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: question
36+
attributes:
37+
label: Your Request
38+
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.
39+
validations:
40+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.md

-25
This file was deleted.

0 commit comments

Comments
 (0)