From 99247d704b539795d20ff422888d4aa6529fe9a2 Mon Sep 17 00:00:00 2001 From: Jonathan White Date: Sun, 8 Dec 2024 17:04:52 -0500 Subject: [PATCH] Use Issue Forms instead of templates Also includes minor updates to the PR template --- .github/ISSUE_TEMPLATE/bug-report.md | 39 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 81 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 19 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 33 ++++++++ .../ISSUE_TEMPLATE/prerelease_bug_report.yml | 83 +++++++++++++++++++ .../release-preview-bug-report.md | 39 --------- .github/PULL_REQUEST_TEMPLATE.md | 8 +- 7 files changed, 201 insertions(+), 101 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/prerelease_bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/release-preview-bug-report.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index a4a3ae2cd4..0000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Bug Report -about: provide information about a problem -title: -labels: bug -assignees: '' - ---- -## Overview -[TIP]: # ( DO NOT include screenshots of your actual database! ) -[NOTE]: # ( Give a BRIEF summary about your problem ) - - -## Steps to Reproduce -[NOTE]: # ( Provide a simple set of steps to reproduce this bug. ) -1. -2. -3. - -## Expected Behavior -[NOTE]: # ( Tell us what you expected to happen ) - - -## Actual Behavior -[NOTE]: # ( Tell us what actually happens ) - - -## Context -[NOTE]: # ( Give us any additional information you may have. ) - - -[NOTE]: # ( Paste debug info from Help → About here ) -KeePassXC - VERSION -Revision: REVISION - -[NOTE]: # ( Pick choices based on your environment ) -Operating System: Windows/Linux/macOS -Desktop Env: Gnome/KDE/XFCE/Mate/Cinnamon -Windowing System: X11/Wayland \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..1e5170361b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,81 @@ +name: Bug Report +description: Provide information about a problem you are experiencing. +type: Bug + +body: + - type: checkboxes + attributes: + label: Have you searched for an existing issue? + description: | + Use the issue search box to see if one already exists for the bug you encountered. + Also take a moment to review our pinned issues. + options: + - label: Yes, I tried searching and reviewed the pinned issues + required: true + + - type: textarea + id: summary + attributes: + label: Brief Summary + description: | + Provide an overview of the problem, include any information that may help us triage this issue. + Provide screenshots if possible, but do NOT show sensitive data (use View -> Allow Screen Capture). + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Provide a simple set of steps to reproduce this bug. + placeholder: | + 1. + 2. + 3. + required: true + + - type: textarea + id: expected_vs_actual + attributes: + label: Expected Versus Actual Behavior + description: Tell us what you expected to happen and what actually happened. + + - type: textarea + id: debug_info + attributes: + label: KeePassXC Debug Information + placeholder: "Paste the output of: Help -> About -> Debug Info" + render: Text + + - type: dropdown + id: os + attributes: + label: Operating System + description: Select your operating system. + options: + - Windows + - Linux + - macOS + - Other (BSD, Haiku, etc) + + - type: dropdown + id: desktop_env + attributes: + label: Linux Desktop Environment + description: If on Linux, please select your desktop environment. + options: + - Gnome + - KDE + - XFCE + - Mate / Cinnamon + - Sway + - i3 + - Other + + - type: dropdown + id: window_system + attributes: + label: Linux Windowing System + description: If on Linux, please select your windowing system. + options: + - X11 + - Wayland diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index d213b4fa3d..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature Request -about: tell us about a new feature you want -title: -labels: new feature -assignees: '' - ---- -## Summary -[TIP]: # ( DO NOT include screenshots of your actual database! ) -[NOTE]: # ( Provide a brief overview of what the new feature is all about ) - - -## Examples -[NOTE]: # ( Show us a picture or mock-up of your proposal ) - - -## Context -[NOTE]: # ( Why does this feature matter to you? What unique circumstances do you have? ) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..d1bfa57a76 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +name: Feature Request +description: Tell us about a new feature you want. +type: Feature + +body: + - type: checkboxes + attributes: + label: Have you searched for an existing feature request? + description: Use the issue search box to see if one already exists for the feature you want. + options: + - label: Yes, I tried searching + required: true + + - type: textarea + id: summary + attributes: + label: Brief Summary + description: | + Provide an overview of the feature you are interested in adding. + Provide screenshots if possible, but do NOT show sensitive data (use View -> Allow Screen Capture). + required: true + + - type: textarea + id: example + attributes: + label: Example + description: Provide an example of how this feature would be used. + + - type: textarea + id: context + attributes: + label: Context + description: Why does this feature matter to you? What unique circumstances do you have? diff --git a/.github/ISSUE_TEMPLATE/prerelease_bug_report.yml b/.github/ISSUE_TEMPLATE/prerelease_bug_report.yml new file mode 100644 index 0000000000..70bd4f72e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/prerelease_bug_report.yml @@ -0,0 +1,83 @@ +name: Pre-Release Bug Report +description: Report an issue with pre-release code (e.g. snapshot builds). +type: Bug +labels: PRE-RELEASE BUG +assignees: droidmonkey + +body: + - type: checkboxes + attributes: + label: Have you searched for an existing issue? + description: | + Use the issue search box to see if one already exists for the bug you encountered. + Also take a moment to review our pinned issues. + options: + - label: Yes, I tried searching and reviewed the pinned issues + required: true + + - type: textarea + id: summary + attributes: + label: Brief Summary + description: | + Provide an overview of the problem, include any information that may help us triage this issue. + Provide screenshots if possible, but do NOT show sensitive data (use View -> Allow Screen Capture). + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Provide a simple set of steps to reproduce this bug. + placeholder: | + 1. + 2. + 3. + required: true + + - type: textarea + id: expected_vs_actual + attributes: + label: Expected Versus Actual Behavior + description: Tell us what you expected to happen and what actually happened. + + - type: textarea + id: debug_info + attributes: + label: KeePassXC Debug Information + placeholder: "Paste the output of: Help -> About -> Debug Info" + render: Text + + - type: dropdown + id: os + attributes: + label: Operating System + description: Select your operating system. + options: + - Windows + - Linux + - macOS + - Other (BSD, Haiku, etc) + + - type: dropdown + id: desktop_env + attributes: + label: Linux Desktop Environment + description: If on Linux, please select your desktop environment. + options: + - Gnome + - KDE + - XFCE + - Mate / Cinnamon + - Sway + - i3 + - Other + + - type: dropdown + id: window_system + attributes: + label: Linux Windowing System + description: If on Linux, please select your windowing system. + options: + - X11 + - Wayland diff --git a/.github/ISSUE_TEMPLATE/release-preview-bug-report.md b/.github/ISSUE_TEMPLATE/release-preview-bug-report.md deleted file mode 100644 index b2fbf65ff6..0000000000 --- a/.github/ISSUE_TEMPLATE/release-preview-bug-report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Release Preview Bug report -about: report a bug with a release preview (e.g., 2.6.0-beta1) -title: -labels: PRE-RELEASE BUG -assignees: droidmonkey - ---- -## Overview -[TIP]: # ( DO NOT include screenshots of your actual database! ) -[NOTE]: # ( Give a BRIEF summary about your problem ) - - -## Steps to Reproduce -[NOTE]: # ( Provide a simple set of steps to reproduce this bug. ) -1. -2. -3. - -## Expected Behavior -[NOTE]: # ( Tell us what you expected to happen ) - - -## Actual Behavior -[NOTE]: # ( Tell us what actually happens ) - - -## Context -[NOTE]: # ( Give us any additional information you may have. ) - - -[NOTE]: # ( Paste debug info from Help → About here ) -KeePassXC - VERSION -Revision: REVISION - -[NOTE]: # ( Pick choices based on your environment ) -Operating System: Windows/Linux/macOS -Desktop Env: Gnome/KDE/XFCE/Mate/Cinnamon -Windowing System: X11/Wayland \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e75bbcd60f..cbb8face9f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,15 @@ [NOTE]: # ( Describe your changes in detail, why is this change required? ) [NOTE]: # ( Explain large or complex code modifications. ) -[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX" ) +[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX". ) ## Screenshots -[TIP]: # ( Do not include screenshots of your actual database! ) - +[NOTE]: # ( Do not include screenshots of your actual database! ) +[TIP]: # ( Use View -> Allow Screen Capture ) ## Testing strategy [NOTE]: # ( Please describe in detail how you tested your changes. ) -[TIP]: # ( We expect new code to be covered by unit tests and documented with doc blocks! ) +[TIP]: # ( We expect new code to be covered by unit tests and include helpful comments. ) ## Type of change