From 78da3bfb90e25dc9f33163f1f2b326e5478b6659 Mon Sep 17 00:00:00 2001 From: Michael Adler Date: Fri, 16 Jun 2023 10:01:57 +0200 Subject: [PATCH] refactor(github): adjust bug report template Convert to YAML format (allowing greater control over input field types) and slightly adjust the wording. Signed-off-by: Michael Adler --- .github/ISSUE_TEMPLATE/bug_report.md | 44 ----------------- .github/ISSUE_TEMPLATE/bug_report.yml | 70 +++++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 44 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index be08fbe8..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Bug report -about: File a bug/issue -labels: ["bug", "triage"] ---- - - - -### Current Behavior - - - -### Expected Behavior - - - -### Steps To Reproduce - - - -### Environment - - - -- OS: [e.g. Debian Bullseye, Ubuntu 18.04, Mac OS X High Sierra, Windows 10, ...] -- OS version: [uname -a] -- wfx Version: [wfx --version] -- Installation method: [e.g. from source, deb packages] - -### Anything else - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..4c5da598 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,70 @@ +--- +name: Bug report +description: File a new bug +labels: [bug, triage] +body: + - type: markdown + attributes: + value: | + Before requesting: search [existing issues](https://github.com/siemens/wfx/labels/bug). + + - type: textarea + attributes: + label: Current Behavior + description: "Description of the current behavior." + validations: + required: true + + - type: textarea + attributes: + label: Expected Behavior + description: "Description of the expected behavior." + validations: + required: true + + - type: textarea + attributes: + label: Steps To Reproduce + description: "Example steps to reproduce the behavior:" + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true + + - type: input + attributes: + label: Environment - OS + description: "e.g. Debian Bullseye, Ubuntu 18.04, Mac OS X High Sierra, Windows 10, ..." + validations: + required: true + + - type: input + attributes: + label: OS version + description: "Output of uname -a (if applicable)" + validations: + required: true + + - type: input + attributes: + label: wfx Version + description: "Output of wfx --version" + validations: + required: true + + - type: input + attributes: + label: Installation method + description: "e.g. from source or via package manager" + validations: + required: true + + - type: textarea + attributes: + label: Anything else + description: "Further hints, links, or references? Any additional information probably helping in root cause analysis." + validations: + required: false