AvengeMedia / AvengeMedia/DankMaterialShell
Add report bug shortcut
- Dominant language
- QML
- Stars
- 8.1k
- Forks
- 515
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 102
Description
### Feature Description
A built in shortcut to report bugs to encourage users to report more bugs. The goal is to lower the friction for users to provide high-quality feedback by automating the collection of system context, logs, and visual evidence.
### **Key Features**
* **Built-in Shortcut:** A configurable keybind (e.g., `Mod+Shift+B`) and a button in the Control Center to trigger the reporting flow.
* **Visual Evidence:**
* **Screenshot/Recording:** snap the current screen or record a short clip of the bug.
* **Annotation Layer:** An overlay to draw arrows or highlight the problematic area before sending.
* **Log Selection:** A checklist UI that lets users choose which logs to include:
* DMS / Systemd Journal / Compositor logs / System resources
* **Automatic sanitation:** Redact Usernames, Strip Sensitive Environment Variables, Mask local IP addresses and MAC addresses.
* **GitHub Integration:** Automatically opens the browser with a pre-filled GitHub Issue template containing the uploaded image link and formatted log blocks.
### Use Case
Less typing and manually gathering evidence. Standardises the reporting flow. Every other desktop environment has it.
### Compositor(s)
- [x] All compositors
- [ ] Niri
- [ ] Hyprland
- [ ] MangoWC (dwl)
- [ ] Sway
- [ ] Other (specify below)
### Proposed Solution
_No response_
### Alternatives/Existing Solutions
_No response_
Contributor guide
Research direction
No files or tests are named. Start by locating the Control Center and configurable keybind entry points, then assess how screenshots, recordings, logs, sanitation, and GitHub issue templates are currently handled. Done would require an agreed scope covering the reporting flow and its evidence and privacy requirements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- desktop, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100