Skip to content

Commit 75a52cd

Browse files
add GitHub issue templates (#565)
* chore: add GitHub issue templates for Android, Linux, and feature requests * remove btl2capfix module option and add instructions for logs Updated bug report template for Android to clarify logging instructions and options for rooted devices. * Refine Linux bug report template details Updated labels and descriptions for clarity in the bug report template. --------- Co-authored-by: Kavish Devar <mail@kavishdevar.me>
1 parent d1b32d5 commit 75a52cd

3 files changed

Lines changed: 225 additions & 0 deletions

File tree

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
name: Bug report (Android)
2+
description: Report a bug in the Android app
3+
labels: ["bug", "android"]
4+
title: "[Android] "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug. Please fill in as much as you can.
10+
- type: input
11+
id: app-version
12+
attributes:
13+
label: App version
14+
description: "Find this in `Settings → About → Version` in the app, or in your phone's app info."
15+
placeholder: "v0.2.5 (build 46)"
16+
validations:
17+
required: true
18+
- type: dropdown
19+
id: app-source
20+
attributes:
21+
label: App source
22+
options:
23+
- GitHub release (FOSS)
24+
- Play Store
25+
- Nightly build
26+
- Built from source
27+
- Other
28+
validations:
29+
required: true
30+
- type: input
31+
id: device
32+
attributes:
33+
label: Device
34+
description: Manufacturer and model.
35+
placeholder: "Google Pixel 8 Pro"
36+
validations:
37+
required: true
38+
- type: input
39+
id: android-version
40+
attributes:
41+
label: Android / OS version
42+
description: Include the OEM skin if relevant.
43+
placeholder: "Android 16, OxygenOS 16, ColorOS 16, ..."
44+
validations:
45+
required: true
46+
- type: dropdown
47+
id: root-method
48+
attributes:
49+
label: Root / hook method
50+
options:
51+
- No root (native L2CAP support)
52+
- Magisk + Xposed
53+
- KernelSU + Xposed
54+
- Other (describe in additional context)
55+
validations:
56+
required: true
57+
- type: dropdown
58+
id: airpods-model
59+
attributes:
60+
label: AirPods model
61+
options:
62+
- AirPods (1st gen)
63+
- AirPods (2nd gen)
64+
- AirPods (3rd gen)
65+
- AirPods (4th gen)
66+
- AirPods (4th gen) with ANC
67+
- AirPods Pro (1st gen)
68+
- AirPods Pro 2 (Lightning)
69+
- AirPods Pro 2 (USB-C)
70+
- AirPods Pro 3
71+
- Other / not sure
72+
validations:
73+
required: true
74+
- type: input
75+
id: firmware
76+
attributes:
77+
label: AirPods firmware
78+
description: Find this under `About` in the app once connected.
79+
placeholder: "8454768"
80+
- type: textarea
81+
id: description
82+
attributes:
83+
label: What happened
84+
description: Describe what you observed and what you expected. Include steps to reproduce if applicable.
85+
validations:
86+
required: true
87+
- type: textarea
88+
id: logs
89+
attributes:
90+
label: Logs
91+
description: |
92+
If you are rooted, give the app root access, open the app, go to `Settings → Troubleshooting → Collect Logs`, and attach the resulting file here.
93+
Without logs most bugs are very hard to diagnose. If you are not, follow these instructions:
94+
95+
(Needs access to a computer, and USB/Wireless Debugging under developer options enabled)
96+
Get the uid: Linux/Mac: `adb shell dumpsys package me.kavishdevar.librepods | grep uid`
97+
Start logs: `adb logcat --uid=<uid>,1002 >> librepods-logs.txt` (1002 is for bluetooth)
98+
99+
Steps for proper logs
100+
- force close the app
101+
- turn off bluetooth
102+
- start logs
103+
- open the app
104+
- turn on bluetooth and connect
105+
106+
placeholder: Paste log content or attach the file
107+
- type: textarea
108+
id: extra
109+
attributes:
110+
label: Additional context
111+
description: Anything else that might help (screenshots, video, related issues, what you've already tried).
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Bug report (Linux)
2+
description: Report a bug in the Linux program
3+
labels: ["bug", "linux"]
4+
title: "[Linux] "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for the report. Please fill in as much as you can.
10+
- type: input
11+
id: app-version
12+
attributes:
13+
label: App version
14+
placeholder: "linux-v0.1.0, or linux-rust commit abc1234"
15+
validations:
16+
required: true
17+
- type: dropdown
18+
id: variant
19+
attributes:
20+
label: Variant
21+
options:
22+
- Rust rewrite (`linux-rust` branch)
23+
- QT version (NOT MAINTAINED! issues will be closed)
24+
validations:
25+
required: true
26+
- type: input
27+
id: distro
28+
attributes:
29+
label: Distro and version
30+
placeholder: "Arch Linux, Fedora 41, Ubuntu 24.04, NixOS 25.05"
31+
validations:
32+
required: true
33+
- type: input
34+
id: desktop
35+
attributes:
36+
label: Desktop environment / compositor
37+
placeholder: "GNOME 47 (Wayland), KDE 6 (X11), Hyprland, ..."
38+
validations:
39+
required: true
40+
- type: dropdown
41+
id: install-method
42+
attributes:
43+
label: Install method (only official sources)
44+
options:
45+
- Built from source (`nix` or otherwise)
46+
- Pre-built binary
47+
- AppImage
48+
- Other
49+
validations:
50+
required: true
51+
- type: dropdown
52+
id: airpods-model
53+
attributes:
54+
label: AirPods model
55+
options:
56+
- AirPods (1st gen)
57+
- AirPods (2nd gen)
58+
- AirPods (3rd gen)
59+
- AirPods (4th gen)
60+
- AirPods (4th gen) with ANC
61+
- AirPods Pro (1st gen)
62+
- AirPods Pro 2 (Lightning)
63+
- AirPods Pro 2 (USB-C)
64+
- AirPods Pro 3
65+
- Other / not sure
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: description
70+
attributes:
71+
label: What happened
72+
description: Describe what you observed and what you expected. Include steps to reproduce if applicable.
73+
validations:
74+
required: true
75+
- type: textarea
76+
id: logs
77+
attributes:
78+
label: Logs and stderr
79+
description: Run the app from a terminal with `--debug` and paste the output.
80+
- type: textarea
81+
id: extra
82+
attributes:
83+
label: Additional context
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Feature request
2+
description: Suggest a new feature or improvement
3+
labels: ["enhancement"]
4+
body:
5+
- type: dropdown
6+
id: scope
7+
attributes:
8+
label: Scope
9+
options:
10+
- Android
11+
- Linux
12+
- Both
13+
- Other
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: problem
18+
attributes:
19+
label: Problem or use case
20+
description: What are you trying to do? What is missing or hard today?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: proposal
25+
attributes:
26+
label: Proposed solution
27+
description: How might it work? UI sketches, behavior, edge cases.
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Alternatives considered

0 commit comments

Comments
 (0)