b44fb74780
* Keep screen-recording state out of world-writable /tmp * Compare the /tmp name across the run instead of requiring it absent Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Fall back to the state directory when there is no runtime dir * Let the /tmp snapshot come back empty Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Resolve the region file the same way in the resizer Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Protect recording fallback state and document its path --------- Co-authored-by: Omabot <omabot@omarchy.org> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2.4 KiB
Reporting Issues and Submitting PRs
Read this when the user wants to report an Omarchy bug, suggest a feature, or contribute a fix upstream.
Omarchy lives at https://github.com/omacom/omarchy. Route requests to the right place:
- Verified bugs -> GitHub issues. Issues are for validated bugs only, not support requests.
- Feature ideas and suggestions -> https://github.com/omacom/omarchy/discussions/categories/suggestions
- Support and "is this a bug?" questions -> the Discord community at https://omarchy.org/discord. Start here when the problem isn't clearly a bug in Omarchy itself.
Filing a Good Bug Report
The bug template asks for system details (CPU, GPU, Omarchy version), a description with steps to reproduce, and diagnostics. Gather them:
omarchy version
# Generate the diagnostic log (also written to /tmp/omarchy-debug.log)
omarchy debug --no-sudo --print
# Interactive variant: `omarchy debug` offers to upload the log to
# logs.omarchy.org (expires after 24h) and prints a shareable URL to
# include in the issue.
Capture the problem on screen. A screenshot or short recording of the bug
is often worth more than the description — see capture.md for
omarchy capture screenshot and omarchy screenrecord. Keep recordings short
and focused on the misbehavior. GitHub issue attachments are added by
drag-and-drop in the web form, so save the capture and hand the user the file
path to attach (gh cannot upload media).
For screen-recording failures specifically, rerun with
OMARCHY_SCREENRECORD_DEBUG=true and attach $XDG_RUNTIME_DIR/omarchy-screenrecord.log (or ${XDG_STATE_HOME:-$HOME/.local/state}/omarchy/omarchy-screenrecord.log without a session runtime directory).
File the issue with gh when available:
gh issue create --repo omacom/omarchy --title "..." --body "..."
Include: what happened, what was expected, steps to reproduce, system details, the debug log URL (or attached log), and the capture.
Submitting a PR
Never develop against /usr/share/omarchy. Clone a working copy instead:
gh repo fork omacom/omarchy --clone
cd omarchy
Follow the repository's own AGENTS.md for style, testing, and commit
conventions — it is the authority on contributions. Keep commits atomic, run
./test/all before pushing, and open the PR with gh pr create. A PR that
fixes a visual problem should include before/after captures (again, see
capture.md).