From a1f0638c3edf9ad9a33c17cba285ef655009612e Mon Sep 17 00:00:00 2001 From: Eric Ferguson Date: Fri, 6 Dec 2024 12:44:52 -0800 Subject: [PATCH] add bug report template --- .github/ISSUE_TEMPLATE/1-change_request.yml | 2 +- .github/ISSUE_TEMPLATE/2-bug_report.yml | 78 +++++++++++++++++++++ 2 files changed, 79 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/2-bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/1-change_request.yml b/.github/ISSUE_TEMPLATE/1-change_request.yml index 96004a8..5b3b83a 100644 --- a/.github/ISSUE_TEMPLATE/1-change_request.yml +++ b/.github/ISSUE_TEMPLATE/1-change_request.yml @@ -32,7 +32,7 @@ body: value: "Changing [...] part of the specification to [...] would meet my needs because [...]" validations: required: false - - type: input + - type: textarea id: need-date attributes: label: Time Sensitivity/Criticality diff --git a/.github/ISSUE_TEMPLATE/2-bug_report.yml b/.github/ISSUE_TEMPLATE/2-bug_report.yml new file mode 100644 index 0000000..7da002c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug_report.yml @@ -0,0 +1,78 @@ +name: "\U0001F41E Bug Report" +description: Report an issue with the specification. +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: dropdown + id: checked-for-duplicates + attributes: + label: Checked for duplicates + description: Have you checked for duplicate issue tickets? + options: + - "No - I haven't checked" + - "Yes - I've already checked" + validations: + required: true + - type: dropdown + id: is-regression + attributes: + label: Is this a regression? + options: + - "No - This is a new bug" + - "Yes - This worked in a previous version" + validations: + required: true + - type: input + id: bug-version + attributes: + label: Version + description: What version of the specification are you observing this bug in? + placeholder: "1.4.0, 1.5.0, develop, etc." + validations: + required: true + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please describe how to reproduce the problem you ran into. If the description is vague (e.g. just a generic error message) and has no reproduction, it will receive a "needs reproduction" label. If no reproduction is provided within a reasonable time-frame, the issue will be closed. + placeholder: Reproduction + validations: + required: true + - type: textarea + id: logs + attributes: + label: Logs + description: Please include browser console and server logs around the time this bug occurred. Optional if provided reproduction. Please try not to insert an image but copy paste the log text. + render: shell + - type: textarea + id: system-info + attributes: + label: System Info + description: Please provide information on the environment you discovered this bug in. + render: shell + placeholder: Browsers, System, Binaries + validations: + required: true + - type: dropdown + id: severity + attributes: + label: Severity + description: Select the severity of this issue. + options: + - Minor + - Moderate + - Major + - Critical + validations: + required: true