From 9df8511d72a4070568ddc8def9dd04c2a18b9d14 Mon Sep 17 00:00:00 2001 From: JesseBot Date: Wed, 7 Dec 2022 11:52:30 +0100 Subject: [PATCH] add better bug template formatting/desc --- .github/ISSUE_TEMPLATE/bug_report.md | 31 ------------------- .../\360\237\220\233-bug-report.md" | 29 +++++++++++++++++ 2 files changed, 29 insertions(+), 31 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 ".github/ISSUE_TEMPLATE/\360\237\220\233-bug-report.md" diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0639d43d..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Local Environment (please complete the following information):** - - OS: [e.g. Debian Bookworm (you can get this with `cat /etc/os-release` on Debian)] - - onboardme Version [e.g. v0.15.9] (You can get this info with `onboardme --version`) - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Exact command you ran to reproduce the behavior: - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Debug log** -Please paste or attach the debug log for the command that is causing issue, but with the debug option like this: - -`onboardme --log_level DEBUG --log_file issue.log` - -(The above will generate an `issue.log` that you can attach or cat out to paste here) diff --git "a/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report.md" "b/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report.md" new file mode 100644 index 00000000..787732ca --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report.md" @@ -0,0 +1,29 @@ +--- +name: "\U0001F41B Bug report" +about: "Create a report to help us improve published features that are broken. \U0001F494" +title: "[BUG] \U0001F41B ..." +labels: bug +assignees: '' + +--- + +## Describe the bug +A clear and concise description of what the bug is. +Example: onboardme throws an error when installing apt packages on Debian. + +### Local Environment (please complete the following information):** + - OS: [e.g. Debian Bookworm (you can get this with `cat /etc/os-release` on Debian)] + - onboardme Version [e.g. v0.15.9] (You can get this info with `onboardme --version`) + +## Steps To Reproduce +Please paste or attach the debug log for the command that is causing issue like this: + +`onboardme --log_level debug --log_file issue.log` + +(The above will generate an `issue.log` (in your current directory) that you can attach, or cat out to paste here) + +### Screenshots +If applicable, add screenshots to help explain your problem. + +### Expected behavior +A clear and concise description of what you expected to happen.