From 3a8f099dde42d4538adb3191dc9b2d41d84a339e Mon Sep 17 00:00:00 2001 From: chrisdebian Date: Tue, 21 Jul 2026 18:44:20 +0100 Subject: [PATCH] docs: add bug report and extension proposal issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 78 +++++++++++++++++++ .github/ISSUE_TEMPLATE/extension_proposal.yml | 37 +++++++++ 2 files changed, 115 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/extension_proposal.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..b82f1d06 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,78 @@ +name: Bug report +description: Something doesn't work as expected under yserver +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug. Please check + [`docs/known-issues.md`](../../docs/known-issues.md) first — it may already be tracked there. + - type: textarea + id: description + attributes: + label: What happened? + description: A clear description of the bug. + validations: + required: true + - type: textarea + id: expected + attributes: + label: What did you expect to happen? + validations: + required: true + - type: textarea + id: repro + attributes: + label: Steps to reproduce + placeholder: | + 1. Launch yserver with ... + 2. Start this window manager / application ... + 3. Do ... + validations: + required: true + - type: dropdown + id: backend + attributes: + label: Backend + options: + - yserver (standalone DRM/KMS) + - ynest (nested) + validations: + required: true + - type: input + id: gpu + attributes: + label: GPU / driver + placeholder: "e.g. AMD RX 9070 XT (RADV, Mesa 26.1.4)" + validations: + required: true + - type: input + id: distro-kernel + attributes: + label: Distro / kernel version + placeholder: "e.g. PikaOS (Debian Sid-based), kernel 6.12.10" + validations: + required: true + - type: input + id: desktop + attributes: + label: Desktop environment / window manager + placeholder: "e.g. Cinnamon, MATE, XFCE, fvwm3" + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: yserver's own log (`RUST_LOG=debug`), and/or the affected client's log if relevant. + render: shell + - type: checkboxes + id: checks + attributes: + label: Checklist + options: + - label: I checked `docs/known-issues.md` and this isn't already tracked there + required: true + - label: I confirmed this doesn't also happen under Xorg with the same setup + required: false diff --git a/.github/ISSUE_TEMPLATE/extension_proposal.yml b/.github/ISSUE_TEMPLATE/extension_proposal.yml new file mode 100644 index 00000000..70de8c73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/extension_proposal.yml @@ -0,0 +1,37 @@ +name: Extension / feature proposal +description: Propose a new X11 extension, protocol feature, or capability +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Proposals for new protocol coverage, not bug reports. See + [`docs/high-level-design.md`](../../docs/high-level-design.md#protocol-scope) for what's + already implemented. + - type: textarea + id: gap + attributes: + label: What's missing? + description: Which extension, request, or capability isn't currently supported. + validations: + required: true + - type: textarea + id: use-case + attributes: + label: Which clients or use cases need this? + description: A real client/application that depends on it is the strongest case. + validations: + required: true + - type: textarea + id: approach + attributes: + label: Proposed approach (optional) + description: If you have a rough idea of the implementation shape, sketch it here. + - type: checkboxes + id: checks + attributes: + label: Checklist + options: + - label: I checked this isn't already listed as a non-goal in `docs/high-level-design.md` + required: true