From 574a2905b5c74bc0d8a94e55ef4508cd87714240 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Mon, 1 Jul 2024 06:58:25 -0700 Subject: [PATCH] Add bug_report.yml template for GitHub issues This is in particular for bug reports of a tool. This is useful rarely but there have been a number of times it has been useful (like right now as I am aware of another bug) so it is good to have it. --- .github/ISSUE_TEMPLATE/bug_report.yml | 55 +++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..c9c6ae3b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,55 @@ +name: Bug report +description: Report a bug with a tool +title: "[Bug] " +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the problem you're reporting. + options: + - label: I have searched for existing issues and did not find anything like this + required: true +- type: textarea + attributes: + label: Describe the bug + description: Please give a **clear** and **concise** description of what the bug is. + validations: + required: true + +- type: textarea + attributes: + label: What you expect + description: | + Please describe what you think it should be instead and why, as best you can (the more details you provide the better). + + validations: + required: true + +- type: textarea + attributes: + label: Environment + description: | + Example: + - **OS**: macOS Sonoma 14.5 + - **Device**: MacBook Pro M1 + - **Shell**: GNU bash, version 5.2.26(1)-release (aarch64-apple-darwin23.2.0) + + **PLEASE** provide **AT** **LEAST** the above items. If you have the **SAME** problem with more than one device please list the above for **ALL** **RELEVANT** **devices** with **any** **relevant** **context**. + value: | + - OS: + - Device: + - Compiler: + render: markdown + validations: + required: true + +- type: textarea + attributes: + label: Anything else? + description: | + Do you have any additional context or information that might be helpful? Please let us know! + + Tip: you can attach files by clicking the text area to highlight it and then click the link that says paste, drop or click to add files. + validations: + required: false +