From a3ab0ef89f7ca019e446833e2abb101e87b48e91 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Sun, 1 Nov 2026 15:13:16 -0800 Subject: [PATCH] docs(github): issue templates ask for the platform bug_report.yml and feature_request.yml get a required platform dropdown (Windows, Linux (KDE Plasma), macOS) first in the form; the bug report's Windows-only wording (ghost tiles, systeminfo, whkdrc, komorebic check) is scoped to Windows or made platform-neutral; the feature request text names all three platforms. config.yml links the Windows docs site plus the Linux and macOS index pages on master (repo-relative GitHub links). Existing fields and labels are kept. Verified: yq parses the three files. Links not fetched (the docs/linux and docs/macos index files exist in the tree; they resolve on GitHub once pushed). --- .github/ISSUE_TEMPLATE/bug_report.yml | 29 ++++++++++++++++------ .github/ISSUE_TEMPLATE/config.yml | 14 ++++++++--- .github/ISSUE_TEMPLATE/feature_request.yml | 15 +++++++++-- 3 files changed, 45 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 885a60d4..70c33855 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -3,10 +3,21 @@ description: File a bug report labels: [bug] title: "[BUG]: " body: + - type: dropdown + id: platform + attributes: + label: Platform + description: Which platform is this about? + options: + - Windows + - Linux (KDE Plasma) + - macOS + validations: + required: true - type: markdown attributes: value: | - Please **do not** open an issue for applications with invisible windows leaving ghost tiles. + Windows only: please **do not** open an issue for applications with invisible windows leaving ghost tiles. You can run `komorebic visible-windows` when the ghost tile is present on your workspace to retrieve the invisible window's exe, class name and title, and then use that information to [ignore the window](https://lgug2z.github.io/komorebi/common-workflows/ignore-windows.html) responsible for the ghost tile. @@ -27,16 +38,20 @@ body: attributes: label: Version Information description: > - Please provide information about the versions of Windows and komorebi - running on your machine. + Please provide information about the versions of your operating system and komorebi + running on your machine (on Linux, your KDE Plasma version too). - Do not submit a bug if you are not using an official version of Windows - such as AtlasOS; only official versions of Windows are supported. + On Windows, do not submit a bug if you are not using an official version of + Windows such as AtlasOS; only official versions of Windows are supported. + + On Windows: ``` systeminfo | findstr /B /C:"OS Name" /B /C:"OS Version" ``` + On Linux or macOS, use your system's version command (for example `uname -a` or `sw_vers`). + ``` komorebic --version ``` @@ -54,7 +69,7 @@ body: attributes: label: Hotkey Configuration description: > - Please provide your whkdrc or komorebi.ahk hotkey configuration file + Please provide your hotkey configuration file (for example whkdrc, komorebi.ahk, skhdrc or sxhkdrc) render: shell - type: textarea validations: @@ -62,5 +77,5 @@ body: attributes: label: Output of komorebic check description: > - Please provide the output of `komorebic check` + Please provide the output of `komorebic check` (on platforms where it is available) render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 436c1fb9..2e083262 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,14 @@ blank_issues_enabled: false contact_links: - - name: Komorebi Documentation + - name: Komorebi Documentation (Windows) url: https://lgug2z.github.io/komorebi/ - about: Please search the documentation website before opening an issue - - name: Komorebi Quickstart Tutorial Video + about: Windows users, please search the documentation website before opening an issue + - name: Komorebi Documentation (Linux, KDE Plasma) + url: https://github.com/LGUG2Z/komorebi/blob/master/docs/linux/index.md + about: Linux users, please read the Linux documentation before opening an issue + - name: Komorebi Documentation (macOS) + url: https://github.com/LGUG2Z/komorebi/blob/master/docs/macos/index.md + about: macOS users, please read the macOS documentation before opening an issue + - name: Komorebi Quickstart Tutorial Video (Windows) url: https://www.youtube.com/watch?v=MMZUAtHbTYY - about: If you are new, please make sure you watch the quickstart tutorial video + about: If you are new to komorebi on Windows, please make sure you watch the quickstart tutorial video diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index cf39777c..fd768f00 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,14 +1,25 @@ name: Feature request -description: Suggest a new feature (Limited to Sponsors, Commercial License Holders, and Collaborators) +description: Suggest a new feature for Windows, Linux or macOS (Limited to Sponsors, Commercial License Holders, and Collaborators) labels: [enhancement] title: "[FEAT]: " body: + - type: dropdown + id: platform + attributes: + label: Platform + description: Which platform is this about? + options: + - Windows + - Linux (KDE Plasma) + - macOS + validations: + required: true - type: dropdown id: Eligibility attributes: label: Eligibility description: > - Feature requests are considered from individuals who are current $5+ monthly sponsors to the project, individual commercial use license holders, and approved collaborators. + Feature requests for all platforms (Windows, Linux and macOS) are considered from individuals who are current $5+ monthly sponsors to the project, individual commercial use license holders, and approved collaborators. Please specify the platform you use to sponsor the project. options: