diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a1cdcd23..0e61c103 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -9,11 +9,20 @@ body: **One problem per issue, please.** If you have hit several, open one issue for each: problems added to the end of an existing report tend to get lost in the thread while the first one is being discussed. + - type: input + id: app-version + attributes: + label: Markpad version + description: Shown in Settings, or in the About / Markpad menu. + placeholder: "2.7.4" + validations: + required: true + - type: dropdown id: install-method attributes: - label: How did you install Markpad? - description: This is often the single most useful line in the report — the installer and the portable build, or a snap and an AppImage, fail in different ways. + label: How did you install it? + description: The installer and the portable build, or a snap and an AppImage, fail in different ways. options: - "Windows — installer (Markpad_…_setup.exe)" - "Windows — portable (Markpad_….exe)" @@ -25,37 +34,25 @@ body: - "Linux — snap" - "Built from source" - "Not sure" - - - type: input - id: app-version - attributes: - label: App version - description: Shown in Settings, or in the About / Markpad menu. - placeholder: "2.7.0" + validations: + required: true - type: input id: os-version attributes: label: OS and version - placeholder: "Windows 11 24H2 · macOS 26.1 · Ubuntu 24.04" - - - type: input - id: linux-details - attributes: - label: "Linux only: distribution, session and GPU/driver" - description: Skip this on Windows and macOS. On Linux it is usually what localises the bug. - placeholder: "CachyOS · GNOME on Wayland (also tried X11) · Intel Arc, Mesa" + description: On Linux, add the desktop session and GPU driver — that is usually what localises the bug. + placeholder: "Windows 11 24H2 · macOS 26.1 · CachyOS, GNOME on Wayland, Intel Arc/Mesa" + validations: + required: true - type: textarea id: what-happens attributes: - label: What happens + label: What happens, and what you expected instead placeholder: Paste any error text from the terminal or a dialog here too — it is often the fastest route to the cause. - - - type: textarea - id: what-expected - attributes: - label: What you expected + validations: + required: true - type: textarea id: steps @@ -67,18 +64,14 @@ body: 3. See … - type: textarea - id: source-document + id: source-markdown attributes: - label: The document, if one triggers it - description: If the bug only shows up with a particular file, attach the `.md` or paste the smallest part that still reproduces it. Reports that depend on a document and do not include one often cannot be reproduced at all. + label: The Markdown that triggers it + description: Paste it as text, not as a screenshot of text — a screenshot has to be retyped before it can be tested, and the retyping is where the actual trigger gets lost. Paste the smallest part that still reproduces it, or attach the `.md`. + render: markdown - type: textarea - id: screenshots + id: extras attributes: - label: Screenshots + label: Screenshots, and anything else description: Drag images straight into this box. - - - type: textarea - id: anything-else - attributes: - label: Anything else diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 303135bb..83849183 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -6,7 +6,9 @@ body: id: problem attributes: label: What problem would this solve? - placeholder: What you were trying to do when you wanted it. + placeholder: What you were trying to do when you wanted it, and any workaround you settled for. + validations: + required: true - type: textarea id: proposal @@ -14,7 +16,29 @@ body: label: What would you like? - type: textarea - id: alternatives + id: reference attributes: - label: What have you tried instead? - description: Workarounds, other editors, or nothing — all three are useful to know. + label: Has another app got this right? + description: A screenshot of it, or just a name, is the single most useful thing you can add. Requests that point at something concrete get answered against that thing; requests that describe it in prose get answered against a guess at what you meant. + placeholder: Drag screenshots straight into this box. + + - type: dropdown + id: platform + attributes: + label: Which platform is this for? + description: Some requests only make sense on one OS — tray icons, package managers, file associations. + options: + - "All platforms" + - "Windows" + - "macOS" + - "Linux" + - "Not sure" + validations: + required: true + + - type: input + id: setup + attributes: + label: Your Markpad version and how you installed it + description: Skip only if the request has nothing to do with your setup. + placeholder: "2.7.4 · Windows installer" diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index e61794c4..34213134 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -9,15 +9,14 @@ body: - type: textarea id: goal attributes: - label: What are you trying to do? - - - type: textarea - id: tried - attributes: - label: What have you tried? + label: What are you trying to do, and what have you tried? + validations: + required: true - type: input id: platform-version attributes: - label: Platform and app version - placeholder: "Windows 11 · Markpad 2.7.0" + label: Platform and Markpad version + placeholder: "Windows 11 · Markpad 2.7.4" + validations: + required: true