6ee243cc37
* Split the end-user omarchy skill into topic guides Move default/omarchy-skill to default/agents/skills/omarchy and break the monolithic SKILL.md into on-demand topic files for Hyprland config, shell plugins, theming, and hooks. Update the skill symlink wiring, relink existing installs through a migration, and correct claims that had drifted from the implementation: plugin hot-reload, terminal reload, menu customization, refresh scopes, theme overlays, background locations, hook timing, and the packaged (not git-managed) system directory. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Add capture and contributing guides to the omarchy skill Cover screenshots, screen recording, OCR text capture, and LocalSend or Taildrop sharing, plus how to route bug reports, suggestions, and support questions upstream with diagnostics and captures of the problem attached. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Scope Hyprland reload guidance to the Lua config files hyprsunset.conf and xdph.conf are read by separate processes, so hyprctl neither applies nor validates them. Document restarting hyprsunset after editing its config, including in the night light example. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
66 lines
2.3 KiB
Markdown
66 lines
2.3 KiB
Markdown
# 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/basecamp/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/basecamp/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:
|
|
|
|
```bash
|
|
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`](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 `/tmp/omarchy-screenrecord.log`.
|
|
|
|
File the issue with `gh` when available:
|
|
|
|
```bash
|
|
gh issue create --repo basecamp/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:
|
|
|
|
```bash
|
|
gh repo fork basecamp/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`](capture.md)).
|