From 7d87a617cc70f71dcbaee4f07aee51d042743acf Mon Sep 17 00:00:00 2001 From: Jonathan Barrow Date: Wed, 24 Apr 2024 14:07:38 -0400 Subject: [PATCH] chore: added issue templates --- .github/ISSUE_TEMPLATE/bug.yaml | 47 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.yaml | 32 ++++++++++++++++++ .github/ISSUE_TEMPLATE/regression.yaml | 46 +++++++++++++++++++++++++ 3 files changed, 125 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml create mode 100644 .github/ISSUE_TEMPLATE/regression.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 0000000..78b4670 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,47 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug", "awaiting-approval"] +assignees: [] +body: + - type: checkboxes + attributes: + label: Checked Existing + description: Ensure you have checked the existing issues, both open and closed, for duplicate issues. + options: + - label: I have checked the repository for duplicate issues. + required: true + - type: markdown + attributes: + value: "We're sorry to hear you had an issue. Please fill out this form to the best of your ability to help us get to the bottom of things." + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Describe the bug in as much detail as possible. + validations: + required: true + - type: textarea + id: expected-result + attributes: + label: What did you expect to happen? + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce? + description: What steps have you taken to see the bug? (OPTIONAL) + placeholder: 1. ... + validations: + required: false + - type: textarea + id: other-info + attributes: + label: Other relevant information. (OPTIONAL) + description: | + Feel free to give us any more information that doesn't fit the above text boxes. + + Tip: You can attach files by clicking this textbox and dragging in files. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 0000000..9969070 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,32 @@ +name: Feature Request +description: Suggest a new feature +title: "[Feature]: " +labels: ["feature", "awaiting-approval"] +assignees: [] +body: + - type: checkboxes + attributes: + label: Checked Existing + description: Ensure you have checked the existing issues, both open and closed, for duplicate issues. + options: + - label: I have checked the repository for duplicate issues. + required: true + - type: textarea + id: what-feature + attributes: + label: What feature do you want to see added? + validations: + required: true + - type: textarea + id: why-feature + attributes: + label: Why do you want to have this feature? + placeholder: A new button! + validations: + required: true + - type: textarea + id: other-details + attributes: + label: Any other details to share? (OPTIONAL) + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/regression.yaml b/.github/ISSUE_TEMPLATE/regression.yaml new file mode 100644 index 0000000..d654579 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/regression.yaml @@ -0,0 +1,46 @@ +name: Regression +description: Report a feature regression +title: "[Regression]: " +labels: ["regression", "awaiting-approval"] +assignees: [] +body: + - type: checkboxes + attributes: + label: Checked Existing + description: Ensure you have checked the existing issues, both open and closed, for duplicate issues. + options: + - label: I have checked the repository for duplicate issues. + required: true + - type: markdown + attributes: + value: "We're sorry to hear something broke. Please fill out this form to the best of your ability to help us get to the bottom of things." + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Describe the regression in as much detail as possible. + validations: + required: true + - type: textarea + id: expected-result + attributes: + label: What was the previous functionality? + validations: + required: true + - type: textarea + id: when + attributes: + label: When did this occur? + description: If known, please link to the commit or pull request which introduced this regression. (OPTIONAL) + validations: + required: false + - type: textarea + id: other-info + attributes: + label: Other relevant information. (OPTIONAL) + description: | + Feel free to give us any more information that doesn't fit the above text boxes. + + Tip: You can attach files by clicking this textbox and dragging in files. + validations: + required: false \ No newline at end of file