From 11c1d75d729512490352090f1d29da4993ae6f37 Mon Sep 17 00:00:00 2001 From: Brenden Matthews Date: Tue, 4 Oct 2022 09:07:25 -0500 Subject: [PATCH] Fix the words. --- .github/ISSUE_TEMPLATE/bug_report.yml | 33 +++++++++++++++++++-------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a6ac82b8..bc8a6008 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,21 +1,25 @@ name: 🐞 Bug Report -description: File a bug report +description: "File a bug report: crashes, unexpected behaviour, and other errors go here." title: "[Bug]: " labels: ["bug", "triage"] body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! If you haven't - done so already, please take a moment to search the existing issues to - see if this has been previously reported. If not, carry on. + Thanks for taking the time to fill out this bug report! + + If you haven't done so already, please take a moment to search the + [existing issues](https://github.com/brndnmtthws/conky/issues) to see if + this has been previously reported. If not, carry on. - type: textarea id: what-happened attributes: label: What happened? - description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! Include screenshots if you have 'em. - value: "A bug happened!" + description: | + Describe the problem, what you expected to happen, and any other + relevant info. You can attach logs, stack traces, and config below. If + required, include screenshots here which demonstrate the problem. + placeholder: Here's what happened validations: required: true - type: input @@ -25,10 +29,18 @@ body: description: What version of Conky are you running? validations: required: true - - type: input + - type: dropdown id: os attributes: - label: What OS/distro are you seeing the problem on? + label: Which OS/distro are you seeing the problem on? + options: + - Ubuntu + - Fedora + - Debian + - Arch Linux + - Gentoo + - Linux (other) + - macOS - type: textarea id: config attributes: @@ -38,6 +50,7 @@ body: - type: markdown attributes: value: | + ## Getting a stack trace If you want to report a crash, please attach a stack trace. To create one with `gdb`, try the following steps: @@ -69,7 +82,7 @@ body: - type: textarea id: stacktrace attributes: - label: Stacktrace + label: Stack trace description: Paste your stacktrace here, if required. render: Shell - type: textarea