From b176cd585a228663af6f53980b0f429332726a93 Mon Sep 17 00:00:00 2001 From: Jesse Squires Date: Fri, 19 Nov 2021 16:44:36 -0800 Subject: [PATCH] Convert bug.md to new issue form https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms --- .github/ISSUE_TEMPLATE/bug.md | 48 ----------------- .github/ISSUE_TEMPLATE/bug.yml | 96 ++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+), 48 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 5cad9c2..0000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -name: Bug report -about: Report a problem you encountered -title: '' -labels: bug -assignees: '' - ---- - - - -*Have you read the [Contributing Guidelines](https://github.com/jessesquires/.github/blob/master/CONTRIBUTING.md)?* - -## General Information - - - - Project version: - - - - Platform/OS version: - - - - IDE version: - - - - Devices: - - - - Any related GitHub issues: - -## Describe the bug -*Clearly and concisely describe the bug.* - -## Steps to reproduce -*Provide numbered steps to follow that reproduce the bug.* - -## Expected behavior -*Clearly and concisely describe what you expected to happen.* - -## Stack trace, compiler error, code snippets -*Paste the full output of any stack trace or compiler error.* -*Include a code snippet that reproduces the described behavior, if applicable* - -## Screenshots -*If applicable, add screenshots, gifs, or videos to help explain your problem.* - -## Additional context -*Add any other useful information about the problem here.* diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..694802d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,96 @@ +name: Bug report +description: Report a problem you encountered +title: "[Bug]: " +labels: ["bug"] +assignees: "" +body: + - type: markdown + attributes: + value: Thanks for taking the time to complete this bug report! + - type: checkboxes + id: terms + attributes: + label: Guidelines + description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/jessesquires/.github/blob/main/CONTRIBUTING.md). + options: + - label: I agree to follow this project's Contributing Guidelines. + required: true + - type: input + id: project + attributes: + label: Project Version + placeholder: "1.0, 1.2.3, 2.5.1" + validations: + required: true + - type: input + id: platform + attributes: + label: Platform and OS Version + placeholder: "iOS 12.1, tvOS 13.0, macOS 10.15.1, Safari 12" + validations: + required: true + - type: input + id: devices + attributes: + label: Affected Devices + placeholder: "iPhone X, iPhone SE, iPad Air, MacBook Pro" + validations: + required: true + - type: input + id: existing-issues + attributes: + label: Existing Issues + description: Are there any similar existing issues? + placeholder: "#42" + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Clearly and concisely describe the bug. + placeholder: Tell us what happened. + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: Steps to reproduce + placeholder: | + 1. + 2. + 3. + ... + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + placeholder: What did you expect to happen? + validations: + required: true + - type: textarea + id: attachments + attributes: + label: Attachments + description: Please include code snippets, stack traces, or compiler errors, if applicable. + placeholder: Code snippets / Stack traces / Compiler errors + validations: + required: false + - type: textarea + id: screenshots + attributes: + label: Screenshots or Videos + description: If applicable, add screenshots, gifs, or videos to help explain your problem. + placeholder: screenshots or videos + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other useful information about the problem here. + placeholder: Is there any additional helpful information you can share? + validations: + required: false