omarchy

Source excerpt starting at line 1.

1# Reporting Issues and Submitting PRs2 3Read this when the user wants to report an Omarchy bug, suggest a feature, or4contribute a fix upstream.5 6Omarchy lives at https://github.com/omacom/omarchy. Route requests to the7right place:8 9- **Verified bugs** -> GitHub issues. Issues are for validated bugs only, not10  support requests.11- **Feature ideas and suggestions** ->12  https://github.com/omacom/omarchy/discussions/categories/suggestions13- **Support and "is this a bug?" questions** -> the Discord community at14  https://omarchy.org/discord. Start here when the problem isn't clearly a bug15  in Omarchy itself.16 17## Filing a Good Bug Report18 19The bug template asks for system details (CPU, GPU, Omarchy version), a20description with steps to reproduce, and diagnostics. Gather them:21 22```bash23omarchy version24 25# Generate the diagnostic log (also written to /tmp/omarchy-debug.log)26omarchy debug --no-sudo --print27 28# Interactive variant: `omarchy debug` offers to upload the log to29# logs.omarchy.org (expires after 24h) and prints a shareable URL to30# include in the issue.31```32 33**Capture the problem on screen.** A screenshot or short recording of the bug34is often worth more than the description — see [`capture.md`](capture.md) for35`omarchy capture screenshot` and `omarchy screenrecord`. Keep recordings short36and focused on the misbehavior. GitHub issue attachments are added by37drag-and-drop in the web form, so save the capture and hand the user the file38path to attach (`gh` cannot upload media).39 40For screen-recording failures specifically, rerun with41`OMARCHY_SCREENRECORD_DEBUG=true` and attach `/tmp/omarchy-screenrecord.log`.42 43File the issue with `gh` when available:44 45```bash46gh issue create --repo omacom/omarchy --title "..." --body "..."47```48 49Include: what happened, what was expected, steps to reproduce, system details,50the debug log URL (or attached log), and the capture.51 52## Submitting a PR53 54Never develop against `/usr/share/omarchy`. Clone a working copy instead:55 56```bash57gh repo fork omacom/omarchy --clone58cd omarchy59```60 61Follow the repository's own `AGENTS.md` for style, testing, and commit62conventions — it is the authority on contributions. Keep commits atomic, run63`./test/all` before pushing, and open the PR with `gh pr create`. A PR that64fixes a visual problem should include before/after captures (again, see65[`capture.md`](capture.md)).66