swadhin / de-omarchy public

Add issue templates (bug/install/feature) and Discord community links

swadhinbiswas committed 2 months ago

605e91d

1 parent e6deb17

commit 605e91d

5 files changed

+191 -0

Files

.github

ISSUE_TEMPLATE

bug_report.yml +79 config.yml +8 feature_request.yml +38 installation-problem.yml +60 README.md +6

Showing 5 changed files+191-0

.github/ISSUE_TEMPLATE/bug_report.yml .github/ISSUE_TEMPLATE/config.yml .github/ISSUE_TEMPLATE/feature_request.yml .github/ISSUE_TEMPLATE/installation-problem.yml README.md

▼.github/ISSUE_TEMPLATE/bug_report.yml

+79-0

@@ -0,0 +1,79 @@
	1	+name: Bug report
	2	+description: Something in de-omarchy is broken or misbehaving
	3	+labels: ["bug", "triage"]
	4	+body:
	5	+ - type: markdown
	6	+ attributes:
	7	+ value: \|
	8	+ Thanks for the report. The environment section matters more than the
	9	+ description — a desktop layer sits on top of your distro, so version drift
	10	+ is the number-one cause of "works on mine".
	11	+
	12	+ - type: dropdown
	13	+ id: area
	14	+ attributes:
	15	+ label: Which part of de-omarchy?
	16	+ options:
	17	+ - Bar / bar widgets (Quickshell)
	18	+ - Panels, menus, launcher
	19	+ - Themes / theming engine
	20	+ - Keybindings / Hyprland config
	21	+ - CLI (`omarchy` and `omarchy-*` commands)
	22	+ - Plugins / Plugin Library / Monitor Manager
	23	+ - Notifications / notification center
	24	+ - Lock screen / idle / screensaver
	25	+ - Other / not sure
	26	+ validations:
	27	+ required: true
	28	+
	29	+ - type: textarea
	30	+ id: what-happened
	31	+ attributes:
	32	+ label: What happened?
	33	+ description: What you saw, and what you expected to see instead.
	34	+ placeholder: Clicked SUPER+CTRL+M expecting Monitor Manager; nothing appeared.
	35	+ validations:
	36	+ required: true
	37	+
	38	+ - type: textarea
	39	+ id: repro
	40	+ attributes:
	41	+ label: Steps to reproduce
	42	+ placeholder: \|
	43	+ 1. …
	44	+ 2. …
	45	+ render: text
	46	+ validations:
	47	+ required: true
	48	+
	49	+ - type: input
	50	+ id: distro
	51	+ attributes:
	52	+ label: Distro and kernel
	53	+ description: "`cat /etc/os-release \| head -2` and `uname -r`"
	54	+ placeholder: CachyOS, 7.1.8-1-cachyos
	55	+ validations:
	56	+ required: true
	57	+
	58	+ - type: textarea
	59	+ id: versions
	60	+ attributes:
	61	+ label: Component versions
	62	+ description: Output of these three commands.
	63	+ render: shell
	64	+ value: \|
	65	+ hyprctl version
	66	+ quickshell --version
	67	+ echo "$OMARCHY_PATH"
	68	+ validations:
	69	+ required: true
	70	+
	71	+ - type: textarea
	72	+ id: logs
	73	+ attributes:
	74	+ label: Logs or console output
	75	+ description: \|
	76	+ Quickshell stderr (from the terminal where you ran `omarchy-restart-shell`,
	77	+ or `journalctl --user --grep quickshell -n 100`). For installer issues,
	78	+ paste the full installer output instead.
	79	+ render: shell
0	80

▼.github/ISSUE_TEMPLATE/config.yml

+8-0

@@ -0,0 +1,8 @@
	1	+blank_issues_enabled: false
	2	+contact_links:
	3	+ - name: Community Discord
	4	+ url: https://discord.gg/4fZ8fawe6
	5	+ about: Questions, help, and general chat — usually faster than an issue for "how do I…" questions.
	6	+ - name: Upstream Omarchy
	7	+ url: https://github.com/basecamp/omarchy
	8	+ about: de-omarchy is a port — issues that reproduce in upstream Omarchy itself belong there.
0	9

▼.github/ISSUE_TEMPLATE/feature_request.yml

+38-0

@@ -0,0 +1,38 @@
	1	+name: Feature request
	2	+description: Suggest an improvement or new capability for de-omarchy
	3	+labels: ["enhancement"]
	4	+body:
	5	+ - type: textarea
	6	+ id: problem
	7	+ attributes:
	8	+ label: Problem or missing capability
	9	+ description: What are you trying to do that de-omarchy doesn't let you do (or makes awkward)?
	10	+ validations:
	11	+ required: true
	12	+
	13	+ - type: textarea
	14	+ id: proposal
	15	+ attributes:
	16	+ label: Proposed solution
	17	+ description: What should happen instead? Commands, keybindings, or UI sketches welcome.
	18	+ validations:
	19	+ required: true
	20	+
	21	+ - type: textarea
	22	+ id: upstream
	23	+ attributes:
	24	+ label: Upstream behavior
	25	+ description: \|
	26	+ Does upstream Omarchy already do this? Link the relevant commit, script,
	27	+ or manual chapter — if it's an upstream feature we lack, porting it is
	28	+ usually the fastest path.
	29	+ - type: dropdown
	30	+ id: contribute
	31	+ attributes:
	32	+ label: Are you willing to help build it?
	33	+ options:
	34	+ - "Yes — I can open a PR"
	35	+ - "Yes — with guidance"
	36	+ - "No — just requesting"
	37	+ validations:
	38	+ required: true
0	39

▼.github/ISSUE_TEMPLATE/installation-problem.yml

+60-0

@@ -0,0 +1,60 @@
	1	+name: Installation problem
	2	+description: install.sh failed, warned, or left something half-deployed
	3	+labels: ["install", "triage"]
	4	+body:
	5	+ - type: markdown
	6	+ attributes:
	7	+ value: \|
	8	+ The installer is designed to be additive and reversible. If it broke
	9	+ something, that's a bug worth fixing properly — this template collects
	10	+ exactly what the fix needs.
	11	+
	12	+ - type: checkboxes
	13	+ id: preflight
	14	+ attributes:
	15	+ label: Pre-flight checklist
	16	+ options:
	17	+ - label: Ran `./scripts/diff-preview.sh` before installing
	18	+ - label: The backup step completed (`~/.de-omarchy-backups/<timestamp>/` exists)
	19	+ - label: Every sudo prompt succeeded (no aborted password prompt)
	20	+ - label: Re-running `./install.sh` does not change the outcome
	21	+
	22	+ - type: dropdown
	23	+ id: phase
	24	+ attributes:
	25	+ label: Which installer phase?
	26	+ options:
	27	+ - Backup
	28	+ - Packages (pacman / AUR helper)
	29	+ - Runtime deploy (rsync to /usr/share/de-omarchy)
	30	+ - User config hooks (symlinks, hyprland.lua block)
	31	+ - PAM / lock screen
	32	+ - Theme init
	33	+ - Verification (scripts/verify.sh)
	34	+ - Uninstaller
	35	+ validations:
	36	+ required: true
	37	+
	38	+ - type: textarea
	39	+ id: output
	40	+ attributes:
	41	+ label: Full installer output
	42	+ description: Including any warnings in yellow — warnings are diagnostics too.
	43	+ render: shell
	44	+ validations:
	45	+ required: true
	46	+
	47	+ - type: input
	48	+ id: distro
	49	+ attributes:
	50	+ label: Distro
	51	+ placeholder: CachyOS rolling
	52	+ validations:
	53	+ required: true
	54	+
	55	+ - type: input
	56	+ id: aur-helper
	57	+ attributes:
	58	+ label: AUR helper
	59	+ description: "`command -v paru yay` — leave blank if neither is installed."
	60	+ placeholder: paru
0	61

▼README.md

+6-0

@@ -6,6 +6,8 @@ de-omarchy takes the [Omarchy](https://github.com/omarchy/omarchy) Hyprland expe
6	6
7	7	Ported from Omarchy by DHH (MIT). See [Credits](#credits).
8	8
	9	+[Discord](https://discord.gg/4fZ8fawe6) · [Issue tracker](https://github.com/swadhinbiswas/de-omarchy/issues) · [Upstream Omarchy](https://github.com/basecamp/omarchy)
	10	+
9	11	---
10	12
11	13	## Highlights
@@ -182,6 +184,10 @@ de-omarchy/
182	184
183	185	The full [Omarchy Manual](manual/) ships vendored — 51 chapters covering navigation, theming, plugins, updates, troubleshooting, and more. Start at [`manual/01-welcome-to-omarchy.md`](manual/01-welcome-to-omarchy.md). Fork-specific deltas live in [`docs/FORK-NOTES.md`](docs/FORK-NOTES.md); where the two disagree, FORK-NOTES wins.
184	186
	187	+## Community
	188	+
	189	+Questions, screenshots, theme shares, and help live on the [de-omarchy Discord](https://discord.gg/4fZ8fawe6) — it's the fastest way to reach people. Bug reports and feature requests belong on the [issue tracker](https://github.com/swadhinbiswas/de-omarchy/issues); GitHub has templates for bugs, installation problems, and features. Anything that reproduces in upstream Omarchy itself should go to [upstream](https://github.com/basecamp/omarchy) instead.
	190	+
185	191	## Credits
186	192
187	193	[Omarchy](https://github.com/basecamp/omarchy) by David Heinemeier Hansson and contributors (MIT). de-omarchy ports its UI, shell, and tooling for non-Omarchy Arch systems; vendored components retain the upstream license — see `LICENSE.upstream`.
188	194